#870 Markup fixes
Merged 5 years ago by ignatenkobrain. Opened 5 years ago by hiwkby.
Unknown source master  into  master

@@ -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 @@

  0123456789-._+

  ....

  

- But do check #Separators for additional restrictions

+ But do check <<Separators>> for additional restrictions

  on using the `+-._++` characters.

  

  === General Naming
@@ -39,17 +39,16 @@

  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] .

+ <<Common Character Set for Package Naming>>.

  If this is the case, refer to:

- link:#Transliteration[ 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]

+ <<Font Packages>>

  and the various sorts of

- Packaging:NamingGuidelines#Addon_Packages_.28General.29[addon packages],

+ <<Addon Packages>>,

  for instance.

  

  === Separators
@@ -59,18 +58,18 @@

  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 <<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 "'''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 "'''Addon Packages <<locales>> '''".

  * Compat packages where the base package name ends in a digit.

- refer to "*link:#MultiplePackages[ Multiple packages with the same base name]*"

+ refer to "*<<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 +120,8 @@

  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 +189,11 @@

  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 '''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 +208,7 @@

  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 +324,7 @@

  

  === 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 +391,8 @@

  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 

+ <<Separators>> about changing "." to "-" applies.

  

  === Python source package naming

  
@@ -441,14 +440,14 @@

  === 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

  

Hello, this PR fixes invalid hyper links.

Please use <<>> syntax for in-page references.

Hello, thanks for your comment. I will use the syntax.

1 new commit added

  • Uses <<>> syntax for in-page references.
5 years ago

Pull-Request has been merged by ignatenkobrain

5 years ago
Metadata