New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add brief tag documentation for all actively used header tags #1415
Conversation
* Version (1001) string | ||
|
||
Package version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't it provide even more information or example? E.g. "This typically corresponds to upstream package version."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Look, this is not a finished book which will go to press and never revisited again. It's about gradually doing at least something, and if I start worrying about making it perfect, it's simply going to stay in the entirely undocumented state forever.
@@ -3,96 +3,296 @@ | |||
## Base package tags | |||
|
|||
* Name (1000) string |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder what is the number in parentheses. Probably some internal ID, but it would be nice to have it mentioned somewhere.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, there is some explanation in https://github.com/rpm-software-management/rpm/blob/master/doc/manual/queryformat.md#tags if I understand this, so this could be interlinked.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is about the package format, not spec tags. The numbers are the tag ID's that the physical headers have, the names are entirely for human convenience.
Added overlapping extension tags + a link from queryformat docs. |
Remove long since obsoleted tags and such, at least mention all spec sections by name. Obviously mountains of information is missing, and what is there is totally chaotic and inconsistent, but at least there's a place to add more now.
No description provided.