doc: covert manpages from doctxt to asciidoc#7826
Open
KLeoUIC wants to merge 6 commits into
Open
Conversation
4 tasks
04f4726 to
d366ee6
Compare
Asciidoc supports all features of doctext, thus the conversion is straight forward. Add a mechanism to look up and include the semantics description in the man page.
Remove doc rules from romio Makefile. MPI-IO API docs are generated together at MPICH binding layer. Asciidoc embed include paths within the .adoc files. Rename doc1_src_txt to doc1_src and so on.
Previously for replaced function, e.g. MPI_Address and MPI_Get_address, the manpage array were accumulated twice. This patch cleans it up.
Contributor
|
test:mpich/doc |
Generate the doc in doc/mansrc/ so asciidoc can reference its include files.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Pull Request Description
The original doctext approach is outdated. Convert to more modern approach using asciidoc (https://asciidoc.org/)
I changed the path names for generating mansrc for C to route to the doc folder.
Author Checklist
Particularly focus on why, not what. Reference background, issues, test failures, xfail entries, etc.
Commits are self-contained and do not do two things at once.
Commit message is of the form:
module: short descriptionCommit message explains what's in the commit.
Whitespace checker. Warnings test. Additional tests via comments.
For non-Argonne authors, check contribution agreement.
If necessary, request an explicit comment from your companies PR approval manager.