From 23aeef3b598c24058979fc75bf0c75a2dffc3c69 Mon Sep 17 00:00:00 2001 From: Hirotaka Wakabayashi Date: Mar 22 2019 04:36:22 +0000 Subject: [PATCH 1/2] Update guidelines/modules/ROOT/pages/Naming.adoc Fixes invalid hyper links. --- diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index 1b85861..a13400c 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -4,7 +4,7 @@ == Versioning guidelines have moved This document previously contained information on both naming and versioning. -The versioning guidelines are now at Packaging:Versioning. +The versioning guidelines are now at xref:Versioning.adoc[Packaging:Versioning]. == Common Character Set for Package Naming @@ -22,7 +22,7 @@ ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789-._+ .... -But do check #Separators for additional restrictions +But do check link:#_separators[#Separators] for additional restrictions on using the `+-._++` characters. === General Naming @@ -39,17 +39,17 @@ as package names SHOULD strive to be consistent within Fedora more than consistent between distributions. Additionally, it is possible that the upstream name does not fall into the -link:#CommonCharacterSet[ Common Character Set] . +link:#_common_character_set_for_package_naming[Common Character Set] . If this is the case, refer to: -link:#Transliteration[ When Upstream Naming is outside of the specified character +link:#_when_upstream_naming_is_outside_of_the_specified_character_set[When Upstream Naming is outside of the specified character set] . Also remember to check whether the type of package you are packaging has specific rules for naming. -Packaging:NamingGuidelines#Font_Packages[Font packages] +link:#_font_packages[#Font_Packages] and the various sorts of -Packaging:NamingGuidelines#Addon_Packages_.28General.29[addon packages], +link:#_addon_packages[#Addon_Packages], for instance. === Separators @@ -59,18 +59,18 @@ 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 link:#MultiplePackages[ Multiple packages with the same base name] +(see link:#_multiple_packages_with_the_same_base_name[Multiple packages with the same base name] 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 "'''link:#AddonHttpdPamSDL[ Addon Packages (httpd, pam and SDL)] '''". +refer to "'''link:#_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 "'''link:#AddonLocale[ Addon Packages (locale)] '''". +refer to "'''link:#_locales[Addon Packages (locale)] '''". * Compat packages where the base package name ends in a digit. -refer to "*link:#MultiplePackages[ Multiple packages with the same base name]*" +refer to "*link:#_multiple_packages_with_the_same_base_name[Multiple packages with the same base name]*" * packages where the upstream name naturally contains an underscore are excluded from this. Examples of these packages include: @@ -121,8 +121,8 @@ but are not required to do so. Conflicting package names, even if they differ by case alone, are not allowed. -Please see -Packaging:Conflicts#Conflicting_Package_Names[Packaging:Conflicts#Conflicting Package Names] +Please see +xref:Conflicts.adoc#_conflicting_package_names[Packaging:Conflicts#Conflicting Package Names] for more details. == Multiple packages with the same base name @@ -190,11 +190,11 @@ 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 '''link:#AddonPerl[ Addon Packages (perl modules)] ''' for details.) +(Refer to '''link:#_perl_modules[Addon Packages (perl modules)] ''' for details.) == Renaming/replacing existing packages -See: Packaging:Guidelines#Renaming.2FReplacing_Existing_Packages +See: xref:index.adoc#renaming-or-replacing-existing-packages[Packaging:Guidelines#Renaming/Replacing Existing Packages] == Documentation Subpackages @@ -209,7 +209,7 @@ Large can refer to either size or quantity of files. Packages containing fonts must be named *[foundryname-]projectname[-fontfamilyname]-fonts*, in lowercase. -For a full explanation, see Packaging/FontsPolicy#Naming. +For a full explanation, see xref:FontsPolicy.adoc#_naming[Packaging/FontsPolicy#Naming]. == Addon Packages @@ -325,7 +325,7 @@ erlang-esdl (erlang module named esdl) === GAP -See the Packaging:GAP#Naming[GAP guidelines] for the proper naming of GAP addon packages. +See the xref:GAP.adoc#_naming[GAP guidelines] for the proper naming of GAP addon packages. === gnome shell extensions @@ -392,8 +392,8 @@ and SHOULD generally take into account the name of the module used when importing it in Python scripts. This name will be prefixed depending on the type of the package. -Note that when a module that has a dot in its name, the -link:#Separators[ usual rule] about changing "." to "-" applies. +Note that when a module that has a dot in its name, the +link:#_separators[usual rule] about changing "." to "-" applies. === Python source package naming @@ -441,14 +441,14 @@ R-waveslim (R module named waveslim) === Sugar Activities The name for all packaged Sugar activities must be prefixed with sugar-. -For more details, see Packaging/SugarActivityGuidelines . +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-. This rule applies even for Tcl/Tk packages that are already prefixed with tcl in the name. -For more details, see Packaging/Tcl#NamingConventions. +For more details, see xref:Tcl.adoc#_naming_conventions[Packaging/Tcl#NamingConventions]. === locales From 7c409ee3043beb7a520c15deb3b7111c972c5629 Mon Sep 17 00:00:00 2001 From: Hirotaka Wakabayashi Date: Mar 23 2019 09:50:47 +0000 Subject: [PATCH 2/2] Uses <<>> syntax for in-page references. --- diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index a13400c..2558b84 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -22,7 +22,7 @@ ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789-._+ .... -But do check link:#_separators[#Separators] for additional restrictions +But do check <> for additional restrictions on using the `+-._++` characters. === General Naming @@ -39,17 +39,16 @@ as package names SHOULD strive to be consistent within Fedora more than consistent between distributions. Additionally, it is possible that the upstream name does not fall into the -link:#_common_character_set_for_package_naming[Common Character Set] . +<>. If this is the case, refer to: -link:#_when_upstream_naming_is_outside_of_the_specified_character_set[When Upstream Naming is outside of the specified character -set] . +<>. Also remember to check whether the type of package you are packaging has specific rules for naming. -link:#_font_packages[#Font_Packages] +<> and the various sorts of -link:#_addon_packages[#Addon_Packages], +<>, for instance. === Separators @@ -59,18 +58,18 @@ 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 link:#_multiple_packages_with_the_same_base_name[Multiple packages with the same base name] +(see <> 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 "'''link:#_httpd_pam_and_sdl[Addon Packages (httpd, pam and SDL)] '''". +refer to "'''Addon Packages <> '''". * packages that are locale specific, and use the locale in the name are excluded, -refer to "'''link:#_locales[Addon Packages (locale)] '''". +refer to "'''Addon Packages <> '''". * Compat packages where the base package name ends in a digit. -refer to "*link:#_multiple_packages_with_the_same_base_name[Multiple packages with the same base name]*" +refer to "*<>*" * packages where the upstream name naturally contains an underscore are excluded from this. Examples of these packages include: @@ -190,7 +189,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 '''link:#_perl_modules[Addon Packages (perl modules)] ''' for details.) +(Refer to '''Addon Packages (<>)] ''' for details.) == Renaming/replacing existing packages @@ -393,7 +392,7 @@ used when importing it in Python scripts. This name will be prefixed depending on the type of the package. Note that when a module that has a dot in its name, the -link:#_separators[usual rule] about changing "." to "-" applies. +<> about changing "." to "-" applies. === Python source package naming