#1089 Typo and formatting fixes
Merged 2 years ago by tibbs. Opened 2 years ago by oturpe.
oturpe/packaging-committee typo-and-formatting-fixes  into  master

Typo and formatting fixes
Otto Urpelainen • 2 years ago  
@@ -482,7 +482,13 @@ 

  

  Build dependencies, however, cannot be automatically determined and MUST be explicitly listed. Refer to the <<buildrequires>>.

  

- Versioned dependencies (build-time or runtime) SHOULD ONLY be used when actually necessary to guarantee that the proper version of a package is present. If a versioned dependency would be satisfied by a version present in three previous Fedora releases then the then a versioned dependency is not needed and a regular unversioned dependency SHOULD be used instead.

+ Versioned dependencies (build-time or runtime) SHOULD ONLY be used

+ when actually necessary to guarantee

+ that the proper version of a package is present.

+ If a versioned dependency would be satisfied

+ by a version present in three previous Fedora releases

+ then a versioned dependency is not needed

+ and a regular unversioned dependency SHOULD be used instead.

  

  A versioned dependency on a package with a defined Epoch MUST be included in that dependency. Otherwise the dependency will not function as expected.

  
@@ -1063,7 +1069,17 @@ 

  

  Configuration files must be marked as such in packages.

  

- As a rule of thumb, use `+%config(noreplace)+` instead of plain `+%config+` unless your best, educated guess is that doing so will break things. In other words, think hard before overwriting local changes in configuration files on package upgrades. An example case when /not/ to use `+noreplace+` is when a package's configuration file changes so that the new package revision wouldn't work with the config file from the previous package revision. Whenever plain `+%config+` is used, add a brief comment to the specfile explaining why.

+ As a rule of thumb,

+ use `+%config(noreplace)+` instead of plain `+%config+`

+ unless your best, educated guess is that doing so will break things.

+ In other words,

+ think hard before overwriting local changes in configuration files n package upgrades.

+ An example case when *not* to use `+noreplace+`

+ is when a package's configuration file changes

+ so that the new package revision wouldn't work

+ with the config file from the previous package revision.

+ Whenever plain `+%config+` is used,

+ add a brief comment to the specfile explaining why.

  

  Don't use %config or %config(noreplace) under /usr. /usr is deemed to not contain configuration files in Fedora.

  

The modified paragraphs were also modified to use semantic linebreaks
as recommended by the README.

rebased onto 76bc577

2 years ago

I do appreciate these cleanups, even if it takes us time time to process them.

Pull-Request has been merged by tibbs

2 years ago
Metadata