Begin the long, long journey towards a reference manual #1385
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
Member
pmatilai
commented
Oct 7, 2020
pmatilai
commented
- Convert our existing shambles of information to GH markdown, add a preliminary index page
- Update doxygen config to shut up obsoletion warnings
Our config was spitting all manner of obsoletion warnings
For rough reproduction steps (yeah I know, this isn't my cup of tea): perl -pi -e 's:\\verbatim:```:g' * perl -pi -e 's:\\endverbatim:```:g' * perl -pi -e 's:\\section .*? :## :g' * perl -pi -e 's:\\page .*? :# :g' * # plus clean up doxygen /* .. */ markings manually. Some of the content is painfully out of sync with stuff on rpm.org but now we can at least meaningfully diff.
The idea here is to start building a comprehensive RPM reference manual where all features are eventually covered. Tutorials belong elsewhere. The doc/manual contents are woefully inadequate and horribly out of date, but even the longest journey starts with the first step.
Closed
The rest need more massaging and/or delicate merging to avoid losing content added in one place but not the other.
Hopefully catching all the relevant differences, and add a link to Lua docs while at it.
Actually describing them all is a whole other matter...
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.