From 5c80e18913e95a0f448fce428e745176ab7de523 Mon Sep 17 00:00:00 2001 From: Marvin Scholz Date: May 03 2021 00:50:08 +0000 Subject: [PATCH 1/4] [Package Naming] Fix bold formatting --- diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index 268349e..7102753 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -317,7 +317,7 @@ This makes a package name format of `+erlang-$NAME+`. When in doubt, use the name of the module that you use when importing it into a script. -'''Example: ''' +*Example:* .... erlang-esdl (Erlang module named esdl) @@ -348,7 +348,7 @@ This makes a package name format of `+libreoffice-$NAME+`. If a package adds a locale to an existing parent package, then it can use an underscore in the locale. -'''Examples: ''' +*Examples:* .... ttfonts-zh_TW (adds zh_TW locale fonts in ttfonts family) @@ -401,7 +401,7 @@ into smaller subpackages e.g., due to dependencies, the extra subpackages SHOULD be named perl-CPANDIST-Something. -'''Examples: ''' +*Examples:* .... perl-Archive-Zip (Archive-Zip is the CPAN distribution name) @@ -434,7 +434,7 @@ Note that when a module that has a dot in its name, the Source packages for Python modules SHOULD be named using the `+python-+` prefix. -'''Examples: ''' +*Examples:* .... python-psycopg (python module named psycopg) From 366974773d356676a16a34ef43c10025ad03ced9 Mon Sep 17 00:00:00 2001 From: Marvin Scholz Date: May 03 2021 01:06:01 +0000 Subject: [PATCH 2/4] [Package Naming] Fix various references --- diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index 7102753..73790bf 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -64,12 +64,12 @@ for more info on this case). There are a few exceptions to the no underscore '_' rule. * httpd, pam, and SDL addon packages are excluded, - refer to "'''Addon Packages <> '''". + refer to "`<<_httpd_pam_and_sdl,Addon Packages (httpd, pam, and SDL)>>`". * packages that are locale specific, and use the locale in the name are excluded, - refer to "'''Addon Packages <> '''". -* Compat packages where the base package name ends in a digit. - refer to "*<>*" + refer to "`<<_locales,Addon Packages (locales)>>`". +* Compat packages where the base package name ends in a digit, + refer to "`<>`". * packages where the upstream name naturally contains an underscore are excluded from this. Examples of these packages include: @@ -190,7 +190,7 @@ you SHOULD default to lowercase naming. The exception to this is for perl module packaging. The CPAN Group and Type SHOULD be capitalized in the name, as if they were proper nouns. -(Refer to '''Addon Packages (<>)] ''' for details.) +(Refer to "`<<_perl_modules,Addon Packages (Perl modules)>>`" for details.) == Renaming/replacing existing packages From 72db63f00400ba1e2109615887635b267409ea2d Mon Sep 17 00:00:00 2001 From: Marvin Scholz Date: May 03 2021 01:14:25 +0000 Subject: [PATCH 3/4] [Package Naming] Minor fixes --- diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index 73790bf..204f2fd 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -61,7 +61,7 @@ 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)>>`". @@ -72,7 +72,7 @@ There are a few exceptions to the no underscore '_' rule. refer to "`<>`". * packages where the upstream name naturally contains an underscore are excluded from this. Examples of these packages include: - ++ .... arptables_jf dhcpv6_client From ea2e576f7f673079433ecea3710c1df66ed1ffd1 Mon Sep 17 00:00:00 2001 From: Marvin Scholz Date: May 03 2021 01:15:37 +0000 Subject: [PATCH 4/4] [Package Naming] Use admonition instead of paragraph Should be more eye-catching while not distract the table of contents. --- diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index 204f2fd..ed07840 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -1,10 +1,12 @@ = Naming Guidelines :toc: -== Versioning guidelines have moved - +[NOTE] +.Versioning guidelines have moved +==== This document previously contained information on both naming and versioning. The versioning guidelines are now at xref:Versioning.adoc[Packaging:Versioning]. +==== == Common Character Set for Package Naming