[PATCHv3 1/2] Fix single quotes, AsciiDoc escaping, and other formatting issues
rev-list-options.txt: -- Remove blank lines after some options subheadings to fix syntax highlighting in Vim -- Typeset literal options, commands, and path names in monospace -- Remove AsciiDoc escapes with literal -- Replace some double quotes with proper AsciiDoc quotes (e.g. ``foo'') Signed-off-by: Jason St. John --- This is a resubmit of a previous patch: http://marc.info/?l=git&m=138431995913311&w=2 I decided to remove the blank lines after option subheadings because the syntax highlighting in Vim actually looks better with them removed. I'm not sure how this affects line-rewrapping of the body text in Emacs. I split the previous patch into two. This patch deals strictly with formatting issues and backticks/literals. The second patch contains the grammatical and typo fixes. Documentation/rev-list-options.txt | 226 + 1 file changed, 78 insertions(+), 148 deletions(-) diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index ec86d09..eb4b6bf 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -18,33 +18,27 @@ ordering and formatting options, such as `--reverse`. -:: -n :: --max-count=:: - Limit the number of commits to output. --skip=:: - Skip 'number' commits before starting to show the commit output. --since=:: --after=:: - Show commits more recent than a specific date. --until=:: --before=:: - Show commits older than a specific date. ifdef::git-rev-list[] --max-age=:: --min-age=:: - Limit the commits output to specified time range. endif::git-rev-list[] --author=:: --committer=:: - Limit the commits output to ones with author/committer header lines that match the specified pattern (regular expression). With more than one `--author=`, @@ -52,7 +46,6 @@ endif::git-rev-list[] chosen (similarly for multiple `--committer=`). --grep-reflog=:: - Limit the commits output to ones with reflog entries that match the specified pattern (regular expression). With more than one `--grep-reflog`, commits whose reflog message @@ -60,7 +53,6 @@ endif::git-rev-list[] error to use this option unless `--walk-reflogs` is in use. --grep=:: - Limit the commits output to ones with log message that matches the specified pattern (regular expression). With more than one `--grep=`, commits whose message @@ -71,46 +63,38 @@ When `--show-notes` is in effect, the message from the notes as if it is part of the log message. --all-match:: - Limit the commits output to ones that match all given --grep, + Limit the commits output to ones that match all given `--grep`, instead of ones that match at least one. -i:: --regexp-ignore-case:: - Match the regexp limiting patterns without regard to letters case. --basic-regexp:: - Consider the limiting patterns to be basic regular expressions; this is the default. -E:: --extended-regexp:: - Consider the limiting patterns to be extended regular expressions instead of the default basic regular expressions. -F:: --fixed-strings:: - Consider the limiting patterns to be fixed strings (don't interpret pattern as a regular expression). --perl-regexp:: - Consider the limiting patterns to be Perl-compatible regexp. Requires libpcre to be compiled in. --remove-empty:: - Stop when a given path disappears from the tree. --merges:: - Print only merge commits. This is exactly the same as `--min-parents=2`. --no-merges:: - Do not print commits with more than one parent. This is exactly the same as `--max-parents=1`. @@ -118,7 +102,6 @@ if it is part of the log message. --max-parents=:: --no-min-parents:: --no-max-parents:: - Show only commits which have at least (or at most) that many parent commits. In particular, `--max-parents=1` is the same as `--no-merges`, `--min-parents=2` is the same as `--merges`. `--max-parents=0` @@ -138,31 +121,26 @@ parents) and `--max-parents=-1` (negative numbers denote no upper limit). brought in to your history by such a merge. --not:: - Reverses the meaning of the '{caret}' prefix (or lack thereof) - for all following revision specifiers, up to the next '--not'. + for all following revision specifiers, up to the next `--not`. --all:: - Pretend as if all the refs in `refs/` are listed on the command line as ''. --branches[=]:: - Pretend as if all the refs in `refs/heads` are listed on the command line as ''. If '' is given, limit branches to ones matching given shell glob. If pattern lacks '?', '{asterisk}', or '[', '/{asterisk}' at the end is implied. --tags[=]:: - Pretend as if all the refs in `refs/tags` are listed
Re: [PATCHv3 1/2] Fix single quotes, AsciiDoc escaping, and other formatting issues
"Jason St. John" writes: > rev-list-options.txt: > -- Remove blank lines after some options subheadings to fix syntax > highlighting in Vim > -- Typeset literal options, commands, and path names in monospace > -- Remove AsciiDoc escapes with literal > -- Replace some double quotes with proper AsciiDoc quotes (e.g. ``foo'') > > Signed-off-by: Jason St. John > --- > This is a resubmit of a previous patch: > http://marc.info/?l=git&m=138431995913311&w=2 > > I decided to remove the blank lines after option subheadings because the > syntax > highlighting in Vim actually looks better with them removed. I'm not sure how > this > affects line-rewrapping of the body text in Emacs. If I wasn't clear, it makes things very bad in Emacs when M-q (fill-paragraph) is used. In any way, consistency is good, so let's queue this version while waiting to hear from those who regularly help updating our docs. > I split the previous patch into two. This patch deals strictly with formatting > issues and backticks/literals. The second patch contains the grammatical and > typo > fixes. Thanks. > > > Documentation/rev-list-options.txt | 226 > + > 1 file changed, 78 insertions(+), 148 deletions(-) > > diff --git a/Documentation/rev-list-options.txt > b/Documentation/rev-list-options.txt > index ec86d09..eb4b6bf 100644 > --- a/Documentation/rev-list-options.txt > +++ b/Documentation/rev-list-options.txt > @@ -18,33 +18,27 @@ ordering and formatting options, such as `--reverse`. > -:: > -n :: > --max-count=:: > - > Limit the number of commits to output. > > --skip=:: > - > Skip 'number' commits before starting to show the commit output. > > --since=:: > --after=:: > - > Show commits more recent than a specific date. > > --until=:: > --before=:: > - > Show commits older than a specific date. > > ifdef::git-rev-list[] > --max-age=:: > --min-age=:: > - > Limit the commits output to specified time range. > endif::git-rev-list[] > > --author=:: > --committer=:: > - > Limit the commits output to ones with author/committer > header lines that match the specified pattern (regular > expression). With more than one `--author=`, > @@ -52,7 +46,6 @@ endif::git-rev-list[] > chosen (similarly for multiple `--committer=`). > > --grep-reflog=:: > - > Limit the commits output to ones with reflog entries that > match the specified pattern (regular expression). With > more than one `--grep-reflog`, commits whose reflog message > @@ -60,7 +53,6 @@ endif::git-rev-list[] > error to use this option unless `--walk-reflogs` is in use. > > --grep=:: > - > Limit the commits output to ones with log message that > matches the specified pattern (regular expression). With > more than one `--grep=`, commits whose message > @@ -71,46 +63,38 @@ When `--show-notes` is in effect, the message from the > notes as > if it is part of the log message. > > --all-match:: > - Limit the commits output to ones that match all given --grep, > + Limit the commits output to ones that match all given `--grep`, > instead of ones that match at least one. > > -i:: > --regexp-ignore-case:: > - > Match the regexp limiting patterns without regard to letters case. > > --basic-regexp:: > - > Consider the limiting patterns to be basic regular expressions; > this is the default. > > -E:: > --extended-regexp:: > - > Consider the limiting patterns to be extended regular expressions > instead of the default basic regular expressions. > > -F:: > --fixed-strings:: > - > Consider the limiting patterns to be fixed strings (don't interpret > pattern as a regular expression). > > --perl-regexp:: > - > Consider the limiting patterns to be Perl-compatible regexp. > Requires libpcre to be compiled in. > > --remove-empty:: > - > Stop when a given path disappears from the tree. > > --merges:: > - > Print only merge commits. This is exactly the same as `--min-parents=2`. > > --no-merges:: > - > Do not print commits with more than one parent. This is > exactly the same as `--max-parents=1`. > > @@ -118,7 +102,6 @@ if it is part of the log message. > --max-parents=:: > --no-min-parents:: > --no-max-parents:: > - > Show only commits which have at least (or at most) that many parent > commits. In particular, `--max-parents=1` is the same as `--no-merges`, > `--min-parents=2` is the same as `--merges`. `--max-parents=0` > @@ -138,31 +121,26 @@ parents) and `--max-parents=-1` (negative numbers > denote no upper limit). > brought in to your history by such a merge. > > --not:: > - > Reverses the meaning of the '{caret}' prefix (or lack thereof) > - for all following revision specifiers, up to the next '--not'. > + for all following revision specifiers, up to the next