Document ways to declare sources and patches #3405
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dmnks
requested changes
Nov 11, 2024
| @@ -472,6 +481,18 @@ software). | |||
|
|
|||
| ### Sub-sections | |||
|
|
|||
| #### `%sourcelist` | |||
|
|
|||
| List of sources, one per row. Handled like unnumbered Source tags. For | |||
There was a problem hiding this comment.
I'd use "line" instead of "row" here, just to be consistent with the rest of the file.
|
|
||
| #### `%patchlist` | ||
|
|
||
| List of patches, one per row. Handled like unnumbered Patch tags. For |
| @@ -170,17 +170,26 @@ Short (< 70 characters) summary of the package. | |||
|
|
|||
| Used to declare source(s) used to build the package. All sources will | |||
| will be packaged into source rpms. | |||
| Arbitrary number of sources may be declared, for example: | |||
| Arbitrary number of sources may be declared. A numbered source is | |||
There was a problem hiding this comment.
I think we should keep the numbered syntax as the recommended, happy-path style here, and only mention the fact that unnumbered declarations are also possible in a separate paragraph below the examples.
I also don't like mixing the numbered and unnumbered styles in the examples. It makes the syntax look more complicated than it really is.
There was a problem hiding this comment.
Same, because the unnumbered declarations are less intuitive, since the macros created to reference the sources are always numbered.
|
Also, @oturpe, sorry for the late response here! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3384
This was written from the perspective of reference manual reader, i.e. trying to document how all the things actual work together. Since various combinations, while possible, do not make much sense, some "X is not recommended" clauses are included. Please instruct if those are not in line with actual recommendations from the RPM team.