storage: fix formatting of container manual pages #403
Conversation
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
The containers-storage(1) and many other manual pages were unreadable.
These files only have section headings (`##` in Markdown, `.SH` in roff)
and lack a title heading (`#`, `.TH`). Fix all of these instances with:
sed -re '1s/^## (.+)/# \1/' storage/docs/containers-storage*.md -i
containers-storage.conf.5.md was somewhat readable, but was also fixed
up for consistency. Remove author info, already present in footer.
A similar problem in the common and image docs was ignored.
These manual pages still have some formatting issues, but this resolves
the main one. No idea whether this documentation is still up-to-date.
Fixes: containers#103
Signed-off-by: Peter Wu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The containers-storage(1) and many other manual pages were unreadable. These files only have section headings (
##in Markdown,.SHin roff) and lack a title heading (#,.TH). Fix all of these instances with:containers-storage.conf.5.md was somewhat readable, but was also fixed up for consistency. Remove author info, already present in footer. A similar problem in the common and image docs was ignored.
These manual pages still have some formatting issues, but this resolves the main one. No idea whether this documentation is still up-to-date.
Fixes: #103