man pages: fix typo, merged lists and wrong indentations - #14038
Open
matttbe wants to merge 5 commits into
Open
Conversation
|
Binary size comparison: |
Merging this PR will improve performance by 3.23%
Performance Changes
Tip Curious why this is faster? Comment Comparing 
Footnotes
|
|
GNU testsuite comparison: |
Contributor
Author
|
I don't think all these issues and regressions are due to this PR only modifying |
The only line with 'converts' with a trailing 's' and s/in/is/. Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
The colon is there to separate the digest and the description. Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
Adding a colon helps to understand the first word is the value, and the rest is the description. Adding an extra whitespace in French as done elsewhere before a colon. Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
Some sentences being part of the same paragraph were not separated by a dot. Also some lists being part of the same paragraph were not prefixed by a dash. Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
The extra section is currently not interpreted as markdown, but as plain text. In the man pages, lines are then merged, except if they are indented. In the --help menus, lines are rendered without merges. Add extra indentations and avoid breaking lines in the man pages, which will introduce new lines in the man pages instead of using the requested width. This also help improving the view in the --help menus. Notes: - the dd man page looks better, but the amount of text per list item might still make it hard to read. Same in the --help menu. Maybe the text could be improved/reduced (in another PR). - the expr man page now follows the same style as test: the expression on the first line, and the description on the second one. Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
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
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 first commits are small and fix some typos, remove unneeded parenthesis, separate values and descriptions, and add missing dots and dashes. The last one is bigger.
The extra section (
after-help) is currently not interpreted as markdown, but as plain text. Lines are then merged, except if they are indented. This was causing issues in various manpages being very hard to read, e.g. for the stat manpage:Before:
After:
Here, a simple correction is done -- similar to what was done in #10737 with only the test manpage: adapt the indentations and avoid new lines in (indented) list items not to force rendering new lines.