From 051dfde6d99b3ce27a10ca5f7043be7e7de9db52 Mon Sep 17 00:00:00 2001 From: Malcolm Inglis Date: Oct 13 2021 15:14:23 +0000 Subject: [PATCH 1/3] Fix Naming Guidelines symbols formatting Motivated by the "httpd, pam, and SDL" section having broken formatting due to the `_` not being escaped. In fixing that, I took the opportunity to normalize the formatting of other symbols on this page too. --- diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index a0ffd02..da0cb0f 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -56,14 +56,14 @@ for instance. === Separators When naming packages for Fedora, -the maintainer MUST use the dash '-' as the delimiter for name parts. -The maintainer MUST NOT use an underscore '_', a plus '+', or a period '.' as a delimiter. -Version numbers used in compat libraries do not need to omit the dot '.' -or change it into a dash '-' +the maintainer MUST use the dash `+-+` as the delimiter for name parts. +The maintainer MUST NOT use an underscore `+_+`, a plus `+++`, or a period `+.+` as a delimiter. +Version numbers used in compat libraries do not need to omit the dot `+.+` +or change it into a dash `+-+` (see <> for more info on this case). -There are a few exceptions to the no underscore '_' rule: +There are a few exceptions to the no underscore `+_+` rule: * httpd, pam, and SDL addon packages are excluded, refer to "`<<_httpd_pam_and_sdl,Addon Packages (httpd, pam, and SDL)>>`". @@ -140,12 +140,12 @@ suffixed by either: * The package version, which SHOULD include the periods present in the original version. ** If the base package name ends with a digit, - a single underscore ("_") MUST be appended to the name, + a single underscore (`+_+`) MUST be appended to the name, and the version MUST be appended to that, in order to avoid confusion over where the name ends and the version begins. ** If the base package name does not end with a digit, the version MUST be directly appended to the package name with no intervening separator. -* a hyphen ("-") followed by a descriptive suffix +* a hyphen (`+-+`) followed by a descriptive suffix such as "stable" which provides some indication as to the nature of the packaged version. @@ -249,9 +249,9 @@ and they are noted below. Packages that rely on Apache httpd, pam, or SDL as a parent use a slightly different naming scheme. pam and SDL addons use the format: `+%{parent}_%{child}+`, -with an underscore "_" as a delimiter. +with an underscore `+_+` as a delimiter. Apache httpd addons use the format: `+mod_%{child}+`, -with an underscore "_" as a delimiter. +with an underscore `+_+` as a delimiter. This naming scheme is usually the same as used for the source tarball name. *Examples:* @@ -424,7 +424,7 @@ MUST be named with the prefix `+python3-+`. * A source package containing primarily a _Python library_ MUST be named with the prefix `+python-+`. -The character `pass:[+]` is reserved for +The character `+++` is reserved for xref:Python.adoc#_extras[Extras]. ==== Python2 binary package naming From d14bb4e72dc47a4d0285bcee49c0991ce499ccb4 Mon Sep 17 00:00:00 2001 From: Malcolm Inglis Date: Oct 13 2021 15:14:23 +0000 Subject: [PATCH 2/3] Fix Naming Guidelines R modules examples header --- diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index da0cb0f..f5fa74d 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -441,7 +441,7 @@ They SHOULD take into account the upstream name of the R module. This makes a package name format of `+R-$NAME+`. When in doubt, use the name of the module that you type to import it in R. -'''Examples: ''' +*Examples:* .... R-mAr (R module named mAr) From 661fa5108ca28c56242d0b6677aee4564e4153c5 Mon Sep 17 00:00:00 2001 From: Malcolm Inglis Date: Oct 13 2021 15:14:23 +0000 Subject: [PATCH 3/3] Fix Naming Guidelines monospace for package names --- diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index f5fa74d..5d4f59c 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -184,8 +184,8 @@ While case sensitivity is not a mandatory requirement, case SHOULD only be used where necessary. Keep in mind to respect the wishes of the upstream maintainers. If they refer to their application as "ORBit", -you SHOULD use "ORBit" as the package name, -and not "orbit". +you SHOULD use `+ORBit+` as the package name, +and not `+orbit+`. However, if they do not express any preference of case, you SHOULD default to lowercase naming. @@ -209,7 +209,7 @@ Large can refer to either size or quantity of files. == Font Packages Packages containing fonts must be named -*[foundryname-]projectname[-fontfamilyname]-fonts*, +`+[foundryname-]projectname[-fontfamilyname]-fonts+`, in lowercase. For a full explanation, see xref:FontsPolicy.adoc#_naming[Packaging/FontsPolicy#Naming]. @@ -276,23 +276,23 @@ The package name SHOULD take into account the upstream name of the emacs component. Where a component adds functionality to more than one emacs compatible editor, -the package name SHOULD be of the form emacs-common-$NAME. +the package name SHOULD be of the form `+emacs-common-$NAME+`. In this case, the main package SHOULD contain only files common to all emacs compatible editors, and the code specific to each SHOULD be placed -in a subpackage reflecting the specific editor $EDITOR-$NAME -e.g., xemacs-$NAME, emacs-$NAME +in a subpackage reflecting the specific editor `+$EDITOR-$NAME+` +e.g., `+xemacs-$NAME+`, `+emacs-$NAME+` (the latter being the package specific to GNU Emacs). An example of this scheme can be found in the package -emacs-common-muse. +`+emacs-common-muse+`. Where a component is designed to add functionality to only a single emacs compatible editor, the main package name SHOULD reflect this -by being called $EDITOR-$NAME. +by being called `+$EDITOR-$NAME+`. An example of this situation can be found in the package -emacs-auctex, which is built only for GNU Emacs. +`+emacs-auctex+`, which is built only for GNU Emacs. *Examples:* @@ -367,34 +367,34 @@ Some examples: [cols=",,",] |============================================= | module name |base lua version |package name -| argparse |(default) |lua-argparse -| argparse | 5.1 | lua5.1-argparse -| sql | 5.2 | lua5.2-sql +| argparse |(default) | `+lua-argparse+` +| argparse | 5.1 | `+lua5.1-argparse+` +| sql | 5.2 | `+lua5.2-sql+` |============================================= === OCaml modules OCaml modules, libraries and syntax extensions -SHOULD be named ocaml-foo. -Examples include: ocaml-extlib, ocaml-ssl. +SHOULD be named `+ocaml-foo+`. +Examples include: `+ocaml-extlib+`, `+ocaml-ssl+`. This naming does not apply to applications written in OCaml, which can be given their normal name. -Examples include: mldonkey, virt-top, cduce. +Examples include: `+mldonkey+`, `+virt-top+`, `+cduce+` === Perl modules Packages of Perl modules (thus they rely on Perl as a parent) use a slightly different naming scheme. -They SHOULD be named perl-CPANDIST -where CPANDIST is the name of the packaged CPAN module distribution +They SHOULD be named `+perl-CPANDIST+` +where `+CPANDIST+` is the name of the packaged CPAN module distribution (which is almost always also the unit of Perl module packaging). In the rare cases when a CPAN module distribution needs to be split into smaller subpackages e.g., due to dependencies, -the extra subpackages SHOULD be named perl-CPANDIST-Something. +the extra subpackages SHOULD be named `+perl-CPANDIST-Something+`. *Examples:* @@ -451,14 +451,14 @@ R-waveslim (R module named waveslim) === Sugar Activities -The name for all packaged Sugar activities must be prefixed with sugar-. +The name for all packaged Sugar activities must be prefixed with `+sugar-+`. For more details, see xref:SugarActivityGuidelines.adoc[Packaging/SugarActivityGuidelines]. === Tcl/Tk extensions -The name for all packaged Tcl/Tk extensions must be prefixed with tcl-. +The name for all packaged Tcl/Tk extensions must be prefixed with `+tcl-+`. This rule applies even for Tcl/Tk packages -that are already prefixed with tcl in the name. +that are already prefixed with `+tcl+` in the name. For more details, see xref:Tcl.adoc#_naming_conventions[Packaging/Tcl#NamingConventions]. === TeX @@ -466,7 +466,7 @@ For more details, see xref:Tcl.adoc#_naming_conventions[Packaging/Tcl#NamingConv As Fedora has switched TeX environments in the past, TeX packages SHOULD not be named after the TeX environment (TeX Live or teTeX) -but instead SHOULD carry the prefix "tex-". +but instead SHOULD carry the prefix `+tex-+`. == Authorship