Skip to content
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

Merged
merged 2 commits into from Oct 28, 2020

Conversation

pmatilai
Copy link
Member

No description provided.

@pmatilai pmatilai changed the title Add brief tag documentation for base and file tags Add brief tag documentation for all actively used header tags Oct 27, 2020
* Version (1001) string

Package version.
Copy link
Contributor

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

Copy link
Member Author

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
Copy link
Contributor

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.

Copy link
Contributor

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.

Copy link
Member Author

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.

@pmatilai
Copy link
Member Author

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.
@pmatilai pmatilai merged commit df22e4a into rpm-software-management:master Oct 28, 2020
@pmatilai pmatilai deleted the tagdoc-pr branch November 10, 2020 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants