{"thread":{"id":"35341","subject":"[PATCHv3 1/2] Fix single quotes, AsciiDoc escaping, and other formatting issues","startedAt":"2013-11-15T01:34:01Z","lastAt":"2013-11-18T21:33:42Z","messageCount":3,"participants":["Jason St. John","Junio C Hamano"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"230657","messageId":"1384479242-21144-1-git-send-email-jstjohn@purdue.edu","threadId":"35341","inReplyTo":null,"subject":"[PATCHv3 1/2] Fix single quotes, AsciiDoc escaping, and other formatting issues","fromName":"Jason St. John","fromEmail":"jstjohn@purdue.edu","sentAt":"2013-11-15T01:34:01Z","receivedAt":"2013-11-15T01:34:01Z","isPatch":false,"sender":{"key":"jstjohn@purdue.edu","avatar":"https://avatars.githubusercontent.com/u/1393510?v=4"},"body":"rev-list-options.txt:\n-- Remove blank lines after some options subheadings to fix syntax\n     highlighting in Vim\n-- Typeset literal options, commands, and path names in monospace\n-- Remove AsciiDoc escapes with literal\n-- Replace some double quotes with proper AsciiDoc quotes (e.g. ``foo'')\n\nSigned-off-by: Jason St. John <jstjohn@purdue.edu>\n---\nThis is a resubmit of a previous patch:\nhttp://marc.info/?l=git&m=138431995913311&w=2\n\nI decided to remove the blank lines after option subheadings because the syntax\nhighlighting in Vim actually looks better with them removed. I'm not sure how this\naffects line-rewrapping of the body text in Emacs.\n\nI split the previous patch into two. This patch deals strictly with formatting\nissues and backticks/literals. The second patch contains the grammatical and typo\nfixes.\n\n\n Documentation/rev-list-options.txt | 226 +++++++++++++------------------------\n 1 file changed, 78 insertions(+), 148 deletions(-)\n\ndiff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt\nindex ec86d09..eb4b6bf 100644\n--- a/Documentation/rev-list-options.txt\n+++ b/Documentation/rev-list-options.txt\n@@ -18,33 +18,27 @@ ordering and formatting options, such as `--reverse`.\n -<number>::\n -n <number>::\n --max-count=<number>::\n-\n \tLimit the number of commits to output.\n \n --skip=<number>::\n-\n \tSkip 'number' commits before starting to show the commit output.\n \n --since=<date>::\n --after=<date>::\n-\n \tShow commits more recent than a specific date.\n \n --until=<date>::\n --before=<date>::\n-\n \tShow commits older than a specific date.\n \n ifdef::git-rev-list[]\n --max-age=<timestamp>::\n --min-age=<timestamp>::\n-\n \tLimit the commits output to specified time range.\n endif::git-rev-list[]\n \n --author=<pattern>::\n --committer=<pattern>::\n-\n \tLimit the commits output to ones with author/committer\n \theader lines that match the specified pattern (regular\n \texpression).  With more than one `--author=<pattern>`,\n@@ -52,7 +46,6 @@ endif::git-rev-list[]\n \tchosen (similarly for multiple `--committer=<pattern>`).\n \n --grep-reflog=<pattern>::\n-\n \tLimit the commits output to ones with reflog entries that\n \tmatch the specified pattern (regular expression). With\n \tmore than one `--grep-reflog`, commits whose reflog message\n@@ -60,7 +53,6 @@ endif::git-rev-list[]\n \terror to use this option unless `--walk-reflogs` is in use.\n \n --grep=<pattern>::\n-\n \tLimit the commits output to ones with log message that\n \tmatches the specified pattern (regular expression).  With\n \tmore than one `--grep=<pattern>`, commits whose message\n@@ -71,46 +63,38 @@ When `--show-notes` is in effect, the message from the notes as\n if it is part of the log message.\n \n --all-match::\n-\tLimit the commits output to ones that match all given --grep,\n+\tLimit the commits output to ones that match all given `--grep`,\n \tinstead of ones that match at least one.\n \n -i::\n --regexp-ignore-case::\n-\n \tMatch the regexp limiting patterns without regard to letters case.\n \n --basic-regexp::\n-\n \tConsider the limiting patterns to be basic regular expressions;\n \tthis is the default.\n \n -E::\n --extended-regexp::\n-\n \tConsider the limiting patterns to be extended regular expressions\n \tinstead of the default basic regular expressions.\n \n -F::\n --fixed-strings::\n-\n \tConsider the limiting patterns to be fixed strings (don't interpret\n \tpattern as a regular expression).\n \n --perl-regexp::\n-\n \tConsider the limiting patterns to be Perl-compatible regexp.\n \tRequires libpcre to be compiled in.\n \n --remove-empty::\n-\n \tStop when a given path disappears from the tree.\n \n --merges::\n-\n \tPrint only merge commits. This is exactly the same as `--min-parents=2`.\n \n --no-merges::\n-\n \tDo not print commits with more than one parent. This is\n \texactly the same as `--max-parents=1`.\n \n@@ -118,7 +102,6 @@ if it is part of the log message.\n --max-parents=<number>::\n --no-min-parents::\n --no-max-parents::\n-\n \tShow only commits which have at least (or at most) that many parent\n \tcommits. In particular, `--max-parents=1` is the same as `--no-merges`,\n \t`--min-parents=2` is the same as `--merges`.  `--max-parents=0`\n@@ -138,31 +121,26 @@ parents) and `--max-parents=-1` (negative numbers denote no upper limit).\n \tbrought in to your history by such a merge.\n \n --not::\n-\n \tReverses the meaning of the '{caret}' prefix (or lack thereof)\n-\tfor all following revision specifiers, up to the next '--not'.\n+\tfor all following revision specifiers, up to the next `--not`.\n \n --all::\n-\n \tPretend as if all the refs in `refs/` are listed on the\n \tcommand line as '<commit>'.\n \n --branches[=<pattern>]::\n-\n \tPretend as if all the refs in `refs/heads` are listed\n \ton the command line as '<commit>'. If '<pattern>' is given, limit\n \tbranches to ones matching given shell glob. If pattern lacks '?',\n \t'{asterisk}', or '[', '/{asterisk}' at the end is implied.\n \n --tags[=<pattern>]::\n-\n \tPretend as if all the refs in `refs/tags` are listed\n \ton the command line as '<commit>'. If '<pattern>' is given, limit\n \ttags to ones matching given shell glob. If pattern lacks '?', '{asterisk}',\n \tor '[', '/{asterisk}' at the end is implied.\n \n --remotes[=<pattern>]::\n-\n \tPretend as if all the refs in `refs/remotes` are listed\n \ton the command line as '<commit>'. If '<pattern>' is given, limit\n \tremote-tracking branches to ones matching given shell glob.\n@@ -175,13 +153,11 @@ parents) and `--max-parents=-1` (negative numbers denote no upper limit).\n \tor '[', '/{asterisk}' at the end is implied.\n \n --ignore-missing::\n-\n \tUpon seeing an invalid object name in the input, pretend as if\n \tthe bad input was not given.\n \n ifndef::git-rev-list[]\n --bisect::\n-\n \tPretend as if the bad bisection ref `refs/bisect/bad`\n \twas listed and as if it was followed by `--not` and the good\n \tbisection refs `refs/bisect/good-*` on the command\n@@ -189,7 +165,6 @@ ifndef::git-rev-list[]\n endif::git-rev-list[]\n \n --stdin::\n-\n \tIn addition to the '<commit>' listed on the command\n \tline, read them from the standard input. If a '--' separator is\n \tseen, stop reading commits and start reading paths to limit the\n@@ -197,36 +172,32 @@ endif::git-rev-list[]\n \n ifdef::git-rev-list[]\n --quiet::\n-\n \tDon't print anything to standard output.  This form\n \tis primarily meant to allow the caller to\n \ttest the exit status to see if a range of objects is fully\n \tconnected (or not).  It is faster than redirecting stdout\n-\tto /dev/null as the output does not have to be formatted.\n+\tto `/dev/null` as the output does not have to be formatted.\n endif::git-rev-list[]\n \n --cherry-mark::\n-\n \tLike `--cherry-pick` (see below) but mark equivalent commits\n \twith `=` rather than omitting them, and inequivalent ones with `+`.\n \n --cherry-pick::\n-\n \tOmit any commit that introduces the same change as\n-\tanother commit on the \"other side\" when the set of\n+\tanother commit on the ``other side'' when the set of\n \tcommits are limited with symmetric difference.\n +\n For example, if you have two branches, `A` and `B`, a usual way\n to list all commits on only one side of them is with\n `--left-right` (see the example below in the description of\n the `--left-right` option).  It however shows the commits that were cherry-picked\n-from the other branch (for example, \"3rd on b\" may be cherry-picked\n+from the other branch (for example, ``3rd on b'' may be cherry-picked\n from branch A).  With this option, such pairs of commits are\n excluded from the output.\n \n --left-only::\n --right-only::\n-\n \tList only commits on the respective side of a symmetric range,\n \ti.e. only those which would be marked `<` resp. `>` by\n \t`--left-right`.\n@@ -238,7 +209,6 @@ More precisely, `--cherry-pick --right-only --no-merges` gives the exact\n list.\n \n --cherry::\n-\n \tA synonym for `--right-only --cherry-mark --no-merges`; useful to\n \tlimit the output to the commits on our side and mark those that\n \thave been applied to the other side of a forked history with\n@@ -247,30 +217,27 @@ list.\n \n -g::\n --walk-reflogs::\n-\n \tInstead of walking the commit ancestry chain, walk\n \treflog entries from the most recent one to older ones.\n \tWhen this option is used you cannot specify commits to\n \texclude (that is, '{caret}commit', 'commit1..commit2',\n \tnor 'commit1\\...commit2' notations cannot be used).\n +\n-With '\\--pretty' format other than oneline (for obvious reasons),\n+With `--pretty` format other than `oneline` (for obvious reasons),\n this causes the output to have two extra lines of information\n taken from the reflog.  By default, 'commit@\\{Nth}' notation is\n used in the output.  When the starting commit is specified as\n 'commit@\\{now}', output also uses 'commit@\\{timestamp}' notation\n-instead.  Under '\\--pretty=oneline', the commit message is\n+instead.  Under `--pretty=oneline`, the commit message is\n prefixed with this information on the same line.\n-This option cannot be combined with '\\--reverse'.\n+This option cannot be combined with `--reverse`.\n See also linkgit:git-reflog[1].\n \n --merge::\n-\n \tAfter a failed merge, show refs that touch files having a\n \tconflict and don't exist on all heads to merge.\n \n --boundary::\n-\n \tOutput excluded boundary commits. Boundary commits are\n \tprefixed with `-`.\n \n@@ -287,11 +254,9 @@ is how to do it, as there are various strategies to simplify the history.\n The following options select the commits to be shown:\n \n <paths>::\n-\n \tCommits modifying the given <paths> are selected.\n \n --simplify-by-decoration::\n-\n \tCommits that are referred by some branch or tag are selected.\n \n Note that extra commits can be shown to give a meaningful history.\n@@ -299,33 +264,27 @@ Note that extra commits can be shown to give a meaningful history.\n The following options affect the way the simplification is performed:\n \n Default mode::\n-\n \tSimplifies the history to the simplest history explaining the\n \tfinal state of the tree. Simplest because it prunes some side\n \tbranches if the end result is the same (i.e. merging branches\n \twith the same content)\n \n --full-history::\n-\n \tSame as the default mode, but does not prune some history.\n \n --dense::\n-\n \tOnly the selected commits are shown, plus some to have a\n \tmeaningful history.\n \n --sparse::\n-\n \tAll commits in the simplified history are shown.\n \n --simplify-merges::\n-\n-\tAdditional option to '--full-history' to remove some needless\n+\tAdditional option to `--full-history` to remove some needless\n \tmerges from the resulting history, as there are no selected\n \tcommits contributing to this merge.\n \n --ancestry-path::\n-\n \tWhen given a range of commits to display (e.g. 'commit1..commit2'\n \tor 'commit2 {caret}commit1'), only display commits that exist\n \tdirectly on the ancestry chain between the 'commit1' and\n@@ -352,36 +311,35 @@ The horizontal line of history A---Q is taken to be the first parent of\n each merge.  The commits are:\n \n * `I` is the initial commit, in which `foo` exists with contents\n-  \"asdf\", and a file `quux` exists with contents \"quux\".  Initial\n+  ``asdf'', and a file `quux` exists with contents ``quux''. Initial\n   commits are compared to an empty tree, so `I` is !TREESAME.\n \n-* In `A`, `foo` contains just \"foo\".\n+* In `A`, `foo` contains just ``foo''.\n \n * `B` contains the same change as `A`.  Its merge `M` is trivial and\n   hence TREESAME to all parents.\n \n-* `C` does not change `foo`, but its merge `N` changes it to \"foobar\",\n+* `C` does not change `foo`, but its merge `N` changes it to ``foobar'',\n   so it is not TREESAME to any parent.\n \n-* `D` sets `foo` to \"baz\".  Its merge `O` combines the strings from\n-  `N` and `D` to \"foobarbaz\"; i.e., it is not TREESAME to any parent.\n+* `D` sets `foo` to ``baz''. Its merge `O` combines the strings from\n+  `N` and `D` to ``foobarbaz''; i.e., it is not TREESAME to any parent.\n \n-* `E` changes `quux` to \"xyzzy\", and its merge `P` combines the\n-  strings to \"quux xyzzy\".  `P` is TREESAME to `O`, but not to `E`.\n+* `E` changes `quux` to ``xyzzy'', and its merge `P` combines the\n+  strings to ``quux xyzzy''. `P` is TREESAME to `O`, but not to `E`.\n \n * `X` is an independent root commit that added a new file `side`, and `Y`\n   modified it. `Y` is TREESAME to `X`. Its merge `Q` added `side` to `P`, and\n   `Q` is TREESAME to `P`, but not to `Y`.\n \n-'rev-list' walks backwards through history, including or excluding\n-commits based on whether '\\--full-history' and/or parent rewriting\n-(via '\\--parents' or '\\--children') are used.  The following settings\n+`rev-list` walks backwards through history, including or excluding\n+commits based on whether `--full-history` and/or parent rewriting\n+(via `--parents` or `--children`) are used. The following settings\n are available.\n \n Default mode::\n-\n \tCommits are included if they are not TREESAME to any parent\n-\t(though this can be changed, see '\\--sparse' below).  If the\n+\t(though this can be changed, see `--sparse` below).  If the\n \tcommit was a merge, and it was TREESAME to one parent, follow\n \tonly that parent.  (Even if there are several TREESAME\n \tparents, follow only one of them.)  Otherwise, follow all\n@@ -400,12 +358,11 @@ available, removed `B` from consideration entirely.  `C` was\n considered via `N`, but is TREESAME.  Root commits are compared to an\n empty tree, so `I` is !TREESAME.\n +\n-Parent/child relations are only visible with --parents, but that does\n+Parent/child relations are only visible with `--parents`, but that does\n not affect the commits selected in default mode, so we have shown the\n parent lines.\n \n --full-history without parent rewriting::\n-\n \tThis mode differs from the default in one point: always follow\n \tall parents of a merge, even if it is TREESAME to one of them.\n \tEven if more than one side of the merge has commits that are\n@@ -425,9 +382,8 @@ about the parent/child relationships between the commits, so we show\n them disconnected.\n \n --full-history with parent rewriting::\n-\n \tOrdinary commits are only included if they are !TREESAME\n-\t(though this can be changed, see '\\--sparse' below).\n+\t(though this can be changed, see `--sparse` below).\n +\n Merges are always included.  However, their parent list is rewritten:\n Along each parent, prune away commits that are not included\n@@ -441,7 +397,7 @@ themselves.  This results in\n \t  `-------------'\n -----------------------------------------------------------------------\n +\n-Compare to '\\--full-history' without rewriting above.  Note that `E`\n+Compare to `--full-history` without rewriting above.  Note that `E`\n was pruned away because it is TREESAME, but the parent list of P was\n rewritten to contain `E`'s parent `I`.  The same happened for `C` and\n `N`, and `X`, `Y` and `Q`.\n@@ -450,22 +406,19 @@ In addition to the above settings, you can change whether TREESAME\n affects inclusion:\n \n --dense::\n-\n \tCommits that are walked are included if they are not TREESAME\n \tto any parent.\n \n --sparse::\n-\n \tAll commits that are walked are included.\n +\n-Note that without '\\--full-history', this still simplifies merges: if\n+Note that without `--full-history`, this still simplifies merges: if\n one of the parents is TREESAME, we follow only that one, so the other\n sides of the merge are never walked.\n \n --simplify-merges::\n-\n \tFirst, build a history graph in the same way that\n-\t'\\--full-history' with parent rewriting does (see above).\n+\t`--full-history` with parent rewriting does (see above).\n +\n Then simplify each commit `C` to its replacement `C'` in the final\n history according to the following rules:\n@@ -484,7 +437,7 @@ history according to the following rules:\n --\n +\n The effect of this is best shown by way of comparing to\n-'\\--full-history' with parent rewriting.  The example turns into:\n+`--full-history` with parent rewriting.  The example turns into:\n +\n -----------------------------------------------------------------------\n \t  .-A---M---N---O\n@@ -494,7 +447,7 @@ The effect of this is best shown by way of comparing to\n \t  `---------'\n -----------------------------------------------------------------------\n +\n-Note the major differences in `N`, `P` and `Q` over '--full-history':\n+Note the major differences in `N`, `P` and `Q` over `--full-history`:\n +\n --\n * `N`'s parent list had `I` removed, because it is an ancestor of the\n@@ -511,11 +464,10 @@ Note the major differences in `N`, `P` and `Q` over '--full-history':\n Finally, there is a fifth simplification mode available:\n \n --ancestry-path::\n-\n \tLimit the displayed commits to those directly on the ancestry\n-\tchain between the \"from\" and \"to\" commits in the given commit\n-\trange. I.e. only display commits that are ancestor of the \"to\"\n-\tcommit, and descendants of the \"from\" commit.\n+\tchain between the ``from'' and ``to'' commits in the given commit\n+\trange. I.e. only display commits that are ancestor of the ``to''\n+\tcommit, and descendants of the ``from'' commit.\n +\n As an example use case, consider the following commit history:\n +\n@@ -530,14 +482,14 @@ As an example use case, consider the following commit history:\n A regular 'D..M' computes the set of commits that are ancestors of `M`,\n but excludes the ones that are ancestors of `D`. This is useful to see\n what happened to the history leading to `M` since `D`, in the sense\n-that \"what does `M` have that did not exist in `D`\". The result in this\n+that ``what does `M` have that did not exist in `D`''. The result in this\n example would be all the commits, except `A` and `B` (and `D` itself,\n of course).\n +\n When we want to find out what commits in `M` are contaminated with the\n bug introduced by `D` and need fixing, however, we might want to view\n only the subset of 'D..M' that are actually descendants of `D`, i.e.\n-excluding `C` and `K`. This is exactly what the '--ancestry-path'\n+excluding `C` and `K`. This is exactly what the `--ancestry-path`\n option does. Applied to the 'D..M' range, it results in:\n +\n -----------------------------------------------------------------------\n@@ -548,7 +500,7 @@ option does. Applied to the 'D..M' range, it results in:\n \t\t\t\tL--M\n -----------------------------------------------------------------------\n \n-The '\\--simplify-by-decoration' option allows you to view only the\n+The `--simplify-by-decoration` option allows you to view only the\n big picture of the topology of the history, by omitting commits\n that are not referenced by tags.  Commits are marked as !TREESAME\n (in other words, kept after history simplification rules described\n@@ -561,50 +513,47 @@ Bisection Helpers\n ~~~~~~~~~~~~~~~~~\n \n --bisect::\n-\n-Limit output to the one commit object which is roughly halfway between\n-included and excluded commits. Note that the bad bisection ref\n-`refs/bisect/bad` is added to the included commits (if it\n-exists) and the good bisection refs `refs/bisect/good-*` are\n-added to the excluded commits (if they exist). Thus, supposing there\n-are no refs in `refs/bisect/`, if\n-\n+\tLimit output to the one commit object which is roughly halfway between\n+\tincluded and excluded commits. Note that the bad bisection ref\n+\t`refs/bisect/bad` is added to the included commits (if it\n+\texists) and the good bisection refs `refs/bisect/good-*` are\n+\tadded to the excluded commits (if they exist). Thus, supposing there\n+\tare no refs in `refs/bisect/`, if\n++\n -----------------------------------------------------------------------\n \t$ git rev-list --bisect foo ^bar ^baz\n -----------------------------------------------------------------------\n-\n++\n outputs 'midpoint', the output of the two commands\n-\n++\n -----------------------------------------------------------------------\n \t$ git rev-list foo ^midpoint\n \t$ git rev-list midpoint ^bar ^baz\n -----------------------------------------------------------------------\n-\n++\n would be of roughly the same length.  Finding the change which\n introduces a regression is thus reduced to a binary search: repeatedly\n generate and test new 'midpoint's until the commit chain is of length\n one.\n \n --bisect-vars::\n-\n-This calculates the same as `--bisect`, except that refs in\n-`refs/bisect/` are not used, and except that this outputs\n-text ready to be eval'ed by the shell. These lines will assign the\n-name of the midpoint revision to the variable `bisect_rev`, and the\n-expected number of commits to be tested after `bisect_rev` is tested\n-to `bisect_nr`, the expected number of commits to be tested if\n-`bisect_rev` turns out to be good to `bisect_good`, the expected\n-number of commits to be tested if `bisect_rev` turns out to be bad to\n-`bisect_bad`, and the number of commits we are bisecting right now to\n-`bisect_all`.\n+\tThis calculates the same as `--bisect`, except that refs in\n+\t`refs/bisect/` are not used, and except that this outputs\n+\ttext ready to be eval'ed by the shell. These lines will assign the\n+\tname of the midpoint revision to the variable `bisect_rev`, and the\n+\texpected number of commits to be tested after `bisect_rev` is tested\n+\tto `bisect_nr`, the expected number of commits to be tested if\n+\t`bisect_rev` turns out to be good to `bisect_good`, the expected\n+\tnumber of commits to be tested if `bisect_rev` turns out to be bad to\n+\t`bisect_bad`, and the number of commits we are bisecting right now to\n+\t`bisect_all`.\n \n --bisect-all::\n-\n-This outputs all the commit objects between the included and excluded\n-commits, ordered by their distance to the included and excluded\n-commits. Refs in `refs/bisect/` are not used. The farthest\n-from them is displayed first. (This is the only one displayed by\n-`--bisect`.)\n+\tThis outputs all the commit objects between the included and excluded\n+\tcommits, ordered by their distance to the included and excluded\n+\tcommits. Refs in `refs/bisect/` are not used. The farthest\n+\tfrom them is displayed first. (This is the only one displayed by\n+\t`--bisect`.)\n +\n This is useful because it makes it easy to choose a good commit to\n test when you want to avoid to test some of them for some reason (they\n@@ -654,9 +603,8 @@ avoid showing the commits from two parallel development track mixed\n together.\n \n --reverse::\n-\n \tOutput the commits in reverse order.\n-\tCannot be combined with '\\--walk-reflogs'.\n+\tCannot be combined with `--walk-reflogs`.\n \n Object Traversal\n ~~~~~~~~~~~~~~~~\n@@ -664,37 +612,32 @@ Object Traversal\n These options are mostly targeted for packing of Git repositories.\n \n --objects::\n-\n \tPrint the object IDs of any object referenced by the listed\n-\tcommits.  '--objects foo ^bar' thus means \"send me\n+\tcommits.  `--objects foo ^bar` thus means ``send me\n \tall object IDs which I need to download if I have the commit\n-\tobject 'bar', but not 'foo'\".\n+\tobject _bar_ but not _foo_''.\n \n --objects-edge::\n-\n-\tSimilar to '--objects', but also print the IDs of excluded\n-\tcommits prefixed with a \"-\" character.  This is used by\n-\tlinkgit:git-pack-objects[1] to build \"thin\" pack, which records\n+\tSimilar to `--objects`, but also print the IDs of excluded\n+\tcommits prefixed with a ``-'' character.  This is used by\n+\tlinkgit:git-pack-objects[1] to build ``thin'' pack, which records\n \tobjects in deltified form based on objects contained in these\n \texcluded commits to reduce network traffic.\n \n --unpacked::\n-\n-\tOnly useful with '--objects'; print the object IDs that are not\n+\tOnly useful with `--objects`; print the object IDs that are not\n \tin packs.\n \n --no-walk[=(sorted|unsorted)]::\n-\n \tOnly show the given commits, but do not traverse their ancestors.\n \tThis has no effect if a range is specified. If the argument\n-\t\"unsorted\" is given, the commits are show in the order they were\n-\tgiven on the command line. Otherwise (if \"sorted\" or no argument\n+\t`unsorted` is given, the commits are show in the order they were\n+\tgiven on the command line. Otherwise (if `sorted` or no argument\n \twas given), the commits are show in reverse chronological order\n \tby commit time.\n \n --do-walk::\n-\n-\tOverrides a previous --no-walk.\n+\tOverrides a previous `--no-walk`.\n \n Commit Formatting\n ~~~~~~~~~~~~~~~~~\n@@ -708,17 +651,15 @@ endif::git-rev-list[]\n include::pretty-options.txt[]\n \n --relative-date::\n-\n \tSynonym for `--date=relative`.\n \n --date=(relative|local|default|iso|rfc|short|raw)::\n-\n \tOnly takes effect for dates shown in human-readable format, such\n-\tas when using \"--pretty\". `log.date` config variable sets a default\n-\tvalue for log command's --date option.\n+\tas when using `--pretty`. `log.date` config variable sets a default\n+\tvalue for log command's `--date` option.\n +\n `--date=relative` shows dates relative to the current time,\n-e.g. \"2 hours ago\".\n+e.g. ``2 hours ago''.\n +\n `--date=local` shows timestamps in user's local time zone.\n +\n@@ -736,18 +677,15 @@ format, often found in E-mail messages.\n \n ifdef::git-rev-list[]\n --header::\n-\n \tPrint the contents of the commit in raw-format; each record is\n \tseparated with a NUL character.\n endif::git-rev-list[]\n \n --parents::\n-\n \tPrint also the parents of the commit (in the form \"commit parent...\").\n \tAlso enables parent rewriting, see 'History Simplification' below.\n \n --children::\n-\n \tPrint also the children of the commit (in the form \"commit child...\").\n \tAlso enables parent rewriting, see 'History Simplification' below.\n \n@@ -757,7 +695,6 @@ ifdef::git-rev-list[]\n endif::git-rev-list[]\n \n --left-right::\n-\n \tMark which side of a symmetric diff a commit is reachable from.\n \tCommits from the left side are prefixed with `<` and those from\n \tthe right with `>`.  If combined with `--boundary`, those\n@@ -787,7 +724,6 @@ you would get an output like this:\n -----------------------------------------------------------------------\n \n --graph::\n-\n \tDraw a text-based graphical representation of the commit history\n \ton the left hand side of the output.  This may cause extra lines\n \tto be printed in between commits, in order for the graph history\n@@ -795,21 +731,20 @@ you would get an output like this:\n +\n This enables parent rewriting, see 'History Simplification' below.\n +\n-This implies the '--topo-order' option by default, but the\n-'--date-order' option may also be specified.\n+This implies the `--topo-order` option by default, but the\n+`--date-order` option may also be specified.\n \n ifdef::git-rev-list[]\n --count::\n \tPrint a number stating how many commits would have been\n \tlisted, and suppress all other output.  When used together\n-\twith '--left-right', instead print the counts for left and\n+\twith `--left-right`, instead print the counts for left and\n \tright commits, separated by a tab. When used together with\n-\t'--cherry-mark', omit patch equivalent commits from these\n+\t`--cherry-mark`, omit patch equivalent commits from these\n \tcounts and print the count for equivalent commits separated\n \tby a tab.\n endif::git-rev-list[]\n \n-\n ifndef::git-rev-list[]\n Diff Formatting\n ~~~~~~~~~~~~~~~\n@@ -819,7 +754,6 @@ Some of them are specific to linkgit:git-rev-list[1], however other diff\n options may be given. See linkgit:git-diff-files[1] for more options.\n \n -c::\n-\n \tWith this option, diff output for a merge commit\n \tshows the differences from each of the parents to the merge result\n \tsimultaneously instead of showing pairwise diff between a parent\n@@ -827,26 +761,22 @@ options may be given. See linkgit:git-diff-files[1] for more options.\n \twhich were modified from all parents.\n \n --cc::\n-\n-\tThis flag implies the '-c' option and further compresses the\n+\tThis flag implies the `-c` option and further compresses the\n \tpatch output by omitting uninteresting hunks whose contents in\n \tthe parents have only two variants and the merge result picks\n \tone of them without modification.\n \n -m::\n-\n \tThis flag makes the merge commits show the full diff like\n \tregular commits; for each merge parent, a separate log entry\n \tand diff is generated. An exception is that only diff against\n-\tthe first parent is shown when '--first-parent' option is given;\n+\tthe first parent is shown when `--first-parent` option is given;\n \tin that case, the output represents the changes the merge\n \tbrought _into_ the then-current branch.\n \n -r::\n-\n \tShow recursive diffs.\n \n -t::\n-\n-\tShow the tree objects in the diff output. This implies '-r'.\n+\tShow the tree objects in the diff output. This implies `-r`.\n endif::git-rev-list[]\n-- \n1.8.4.2\n"},{"id":"230658","messageId":"1384479242-21144-2-git-send-email-jstjohn@purdue.edu","threadId":"35341","inReplyTo":"1384479242-21144-1-git-send-email-jstjohn@purdue.edu","subject":"[PATCHv3 2/2] Documentation/rev-list-options.txt: fix some grammatical issues and typos","fromName":"Jason St. John","fromEmail":"jstjohn@purdue.edu","sentAt":"2013-11-15T01:34:02Z","receivedAt":"2013-11-15T01:34:02Z","isPatch":false,"sender":{"key":"jstjohn@purdue.edu","avatar":"https://avatars.githubusercontent.com/u/1393510?v=4"},"body":"Various fixes:\n-- fix typos (e.g. \"show\" -> \"shown\")\n-- use \"regular expression(s)\" instead of \"regexp\" where appropriate\n-- reword some sentences for easier reading\n-- fix/improve some grammatical issues (e.g. comma usage)\n-- add missing articles (e.g. \"the\")\n-- change \"E-mail\" to \"email\"\n\nSigned-off-by: Jason St. John <jstjohn@purdue.edu>\n---\nI changed \"E-mail\" to \"email\" because that is clearly the dominant form:\nhttp://www.google.com/trends/explore?q=#q=%22email%22%2C%20%22E-mail%22&cmpt=q\n\n\n Documentation/rev-list-options.txt | 27 ++++++++++++++-------------\n 1 file changed, 14 insertions(+), 13 deletions(-)\n\ndiff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt\nindex eb4b6bf..2991d70 100644\n--- a/Documentation/rev-list-options.txt\n+++ b/Documentation/rev-list-options.txt\n@@ -68,7 +68,8 @@ if it is part of the log message.\n \n -i::\n --regexp-ignore-case::\n-\tMatch the regexp limiting patterns without regard to letters case.\n+\tMatch the regular expression limiting patterns without regard to letter\n+\tcase.\n \n --basic-regexp::\n \tConsider the limiting patterns to be basic regular expressions;\n@@ -85,7 +86,7 @@ if it is part of the log message.\n \tpattern as a regular expression).\n \n --perl-regexp::\n-\tConsider the limiting patterns to be Perl-compatible regexp.\n+\tConsider the limiting patterns to be Perl-compatible regular expressions.\n \tRequires libpcre to be compiled in.\n \n --remove-empty::\n@@ -191,9 +192,9 @@ endif::git-rev-list[]\n For example, if you have two branches, `A` and `B`, a usual way\n to list all commits on only one side of them is with\n `--left-right` (see the example below in the description of\n-the `--left-right` option).  It however shows the commits that were cherry-picked\n-from the other branch (for example, ``3rd on b'' may be cherry-picked\n-from branch A).  With this option, such pairs of commits are\n+the `--left-right` option). However, it shows the commits that were\n+cherry-picked from the other branch (for example, ``3rd on b'' may be\n+cherry-picked from branch A). With this option, such pairs of commits are\n excluded from the output.\n \n --left-only::\n@@ -447,7 +448,7 @@ The effect of this is best shown by way of comparing to\n \t  `---------'\n -----------------------------------------------------------------------\n +\n-Note the major differences in `N`, `P` and `Q` over `--full-history`:\n+Note the major differences in `N`, `P`, and `Q` over `--full-history`:\n +\n --\n * `N`'s parent list had `I` removed, because it is an ancestor of the\n@@ -467,7 +468,7 @@ Finally, there is a fifth simplification mode available:\n \tLimit the displayed commits to those directly on the ancestry\n \tchain between the ``from'' and ``to'' commits in the given commit\n \trange. I.e. only display commits that are ancestor of the ``to''\n-\tcommit, and descendants of the ``from'' commit.\n+\tcommit and descendants of the ``from'' commit.\n +\n As an example use case, consider the following commit history:\n +\n@@ -631,9 +632,9 @@ These options are mostly targeted for packing of Git repositories.\n --no-walk[=(sorted|unsorted)]::\n \tOnly show the given commits, but do not traverse their ancestors.\n \tThis has no effect if a range is specified. If the argument\n-\t`unsorted` is given, the commits are show in the order they were\n+\t`unsorted` is given, the commits are shown in the order they were\n \tgiven on the command line. Otherwise (if `sorted` or no argument\n-\twas given), the commits are show in reverse chronological order\n+\twas given), the commits are shown in reverse chronological order\n \tby commit time.\n \n --do-walk::\n@@ -656,7 +657,7 @@ include::pretty-options.txt[]\n --date=(relative|local|default|iso|rfc|short|raw)::\n \tOnly takes effect for dates shown in human-readable format, such\n \tas when using `--pretty`. `log.date` config variable sets a default\n-\tvalue for log command's `--date` option.\n+\tvalue for the log command's `--date` option.\n +\n `--date=relative` shows dates relative to the current time,\n e.g. ``2 hours ago''.\n@@ -666,9 +667,9 @@ e.g. ``2 hours ago''.\n `--date=iso` (or `--date=iso8601`) shows timestamps in ISO 8601 format.\n +\n `--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822\n-format, often found in E-mail messages.\n+format, often found in email messages.\n +\n-`--date=short` shows only date but not time, in `YYYY-MM-DD` format.\n+`--date=short` shows only the date, but not the time, in `YYYY-MM-DD` format.\n +\n `--date=raw` shows the date in the internal raw Git format `%s %z` format.\n +\n@@ -749,7 +750,7 @@ ifndef::git-rev-list[]\n Diff Formatting\n ~~~~~~~~~~~~~~~\n \n-Below are listed options that control the formatting of diff output.\n+Listed below are options that control the formatting of diff output.\n Some of them are specific to linkgit:git-rev-list[1], however other diff\n options may be given. See linkgit:git-diff-files[1] for more options.\n \n-- \n1.8.4.2\n"},{"id":"230782","messageId":"xmqqa9h1bdjd.fsf@gitster.dls.corp.google.com","threadId":"35341","inReplyTo":"1384479242-21144-1-git-send-email-jstjohn@purdue.edu","subject":"Re: [PATCHv3 1/2] Fix single quotes, AsciiDoc escaping, and other formatting issues","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2013-11-18T21:33:42Z","receivedAt":"2013-11-18T21:33:42Z","isPatch":false,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Jason St. John\" <jstjohn@purdue.edu> writes:\n\n> rev-list-options.txt:\n> -- Remove blank lines after some options subheadings to fix syntax\n>      highlighting in Vim\n> -- Typeset literal options, commands, and path names in monospace\n> -- Remove AsciiDoc escapes with literal\n> -- Replace some double quotes with proper AsciiDoc quotes (e.g. ``foo'')\n>\n> Signed-off-by: Jason St. John <jstjohn@purdue.edu>\n> ---\n> This is a resubmit of a previous patch:\n> http://marc.info/?l=git&m=138431995913311&w=2\n>\n> I decided to remove the blank lines after option subheadings because the syntax\n> highlighting in Vim actually looks better with them removed. I'm not sure how this\n> affects line-rewrapping of the body text in Emacs.\n\nIf I wasn't clear, it makes things very bad in Emacs when M-q\n(fill-paragraph) is used.\n\nIn any way, consistency is good, so let's queue this version while\nwaiting to hear from those who regularly help updating our docs. \n\n> I split the previous patch into two. This patch deals strictly with formatting\n> issues and backticks/literals. The second patch contains the grammatical and typo\n> fixes.\n\nThanks.\n\n>\n>\n>  Documentation/rev-list-options.txt | 226 +++++++++++++------------------------\n>  1 file changed, 78 insertions(+), 148 deletions(-)\n>\n> diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt\n> index ec86d09..eb4b6bf 100644\n> --- a/Documentation/rev-list-options.txt\n> +++ b/Documentation/rev-list-options.txt\n> @@ -18,33 +18,27 @@ ordering and formatting options, such as `--reverse`.\n>  -<number>::\n>  -n <number>::\n>  --max-count=<number>::\n> -\n>  \tLimit the number of commits to output.\n>  \n>  --skip=<number>::\n> -\n>  \tSkip 'number' commits before starting to show the commit output.\n>  \n>  --since=<date>::\n>  --after=<date>::\n> -\n>  \tShow commits more recent than a specific date.\n>  \n>  --until=<date>::\n>  --before=<date>::\n> -\n>  \tShow commits older than a specific date.\n>  \n>  ifdef::git-rev-list[]\n>  --max-age=<timestamp>::\n>  --min-age=<timestamp>::\n> -\n>  \tLimit the commits output to specified time range.\n>  endif::git-rev-list[]\n>  \n>  --author=<pattern>::\n>  --committer=<pattern>::\n> -\n>  \tLimit the commits output to ones with author/committer\n>  \theader lines that match the specified pattern (regular\n>  \texpression).  With more than one `--author=<pattern>`,\n> @@ -52,7 +46,6 @@ endif::git-rev-list[]\n>  \tchosen (similarly for multiple `--committer=<pattern>`).\n>  \n>  --grep-reflog=<pattern>::\n> -\n>  \tLimit the commits output to ones with reflog entries that\n>  \tmatch the specified pattern (regular expression). With\n>  \tmore than one `--grep-reflog`, commits whose reflog message\n> @@ -60,7 +53,6 @@ endif::git-rev-list[]\n>  \terror to use this option unless `--walk-reflogs` is in use.\n>  \n>  --grep=<pattern>::\n> -\n>  \tLimit the commits output to ones with log message that\n>  \tmatches the specified pattern (regular expression).  With\n>  \tmore than one `--grep=<pattern>`, commits whose message\n> @@ -71,46 +63,38 @@ When `--show-notes` is in effect, the message from the notes as\n>  if it is part of the log message.\n>  \n>  --all-match::\n> -\tLimit the commits output to ones that match all given --grep,\n> +\tLimit the commits output to ones that match all given `--grep`,\n>  \tinstead of ones that match at least one.\n>  \n>  -i::\n>  --regexp-ignore-case::\n> -\n>  \tMatch the regexp limiting patterns without regard to letters case.\n>  \n>  --basic-regexp::\n> -\n>  \tConsider the limiting patterns to be basic regular expressions;\n>  \tthis is the default.\n>  \n>  -E::\n>  --extended-regexp::\n> -\n>  \tConsider the limiting patterns to be extended regular expressions\n>  \tinstead of the default basic regular expressions.\n>  \n>  -F::\n>  --fixed-strings::\n> -\n>  \tConsider the limiting patterns to be fixed strings (don't interpret\n>  \tpattern as a regular expression).\n>  \n>  --perl-regexp::\n> -\n>  \tConsider the limiting patterns to be Perl-compatible regexp.\n>  \tRequires libpcre to be compiled in.\n>  \n>  --remove-empty::\n> -\n>  \tStop when a given path disappears from the tree.\n>  \n>  --merges::\n> -\n>  \tPrint only merge commits. This is exactly the same as `--min-parents=2`.\n>  \n>  --no-merges::\n> -\n>  \tDo not print commits with more than one parent. This is\n>  \texactly the same as `--max-parents=1`.\n>  \n> @@ -118,7 +102,6 @@ if it is part of the log message.\n>  --max-parents=<number>::\n>  --no-min-parents::\n>  --no-max-parents::\n> -\n>  \tShow only commits which have at least (or at most) that many parent\n>  \tcommits. In particular, `--max-parents=1` is the same as `--no-merges`,\n>  \t`--min-parents=2` is the same as `--merges`.  `--max-parents=0`\n> @@ -138,31 +121,26 @@ parents) and `--max-parents=-1` (negative numbers denote no upper limit).\n>  \tbrought in to your history by such a merge.\n>  \n>  --not::\n> -\n>  \tReverses the meaning of the '{caret}' prefix (or lack thereof)\n> -\tfor all following revision specifiers, up to the next '--not'.\n> +\tfor all following revision specifiers, up to the next `--not`.\n>  \n>  --all::\n> -\n>  \tPretend as if all the refs in `refs/` are listed on the\n>  \tcommand line as '<commit>'.\n>  \n>  --branches[=<pattern>]::\n> -\n>  \tPretend as if all the refs in `refs/heads` are listed\n>  \ton the command line as '<commit>'. If '<pattern>' is given, limit\n>  \tbranches to ones matching given shell glob. If pattern lacks '?',\n>  \t'{asterisk}', or '[', '/{asterisk}' at the end is implied.\n>  \n>  --tags[=<pattern>]::\n> -\n>  \tPretend as if all the refs in `refs/tags` are listed\n>  \ton the command line as '<commit>'. If '<pattern>' is given, limit\n>  \ttags to ones matching given shell glob. If pattern lacks '?', '{asterisk}',\n>  \tor '[', '/{asterisk}' at the end is implied.\n>  \n>  --remotes[=<pattern>]::\n> -\n>  \tPretend as if all the refs in `refs/remotes` are listed\n>  \ton the command line as '<commit>'. If '<pattern>' is given, limit\n>  \tremote-tracking branches to ones matching given shell glob.\n> @@ -175,13 +153,11 @@ parents) and `--max-parents=-1` (negative numbers denote no upper limit).\n>  \tor '[', '/{asterisk}' at the end is implied.\n>  \n>  --ignore-missing::\n> -\n>  \tUpon seeing an invalid object name in the input, pretend as if\n>  \tthe bad input was not given.\n>  \n>  ifndef::git-rev-list[]\n>  --bisect::\n> -\n>  \tPretend as if the bad bisection ref `refs/bisect/bad`\n>  \twas listed and as if it was followed by `--not` and the good\n>  \tbisection refs `refs/bisect/good-*` on the command\n> @@ -189,7 +165,6 @@ ifndef::git-rev-list[]\n>  endif::git-rev-list[]\n>  \n>  --stdin::\n> -\n>  \tIn addition to the '<commit>' listed on the command\n>  \tline, read them from the standard input. If a '--' separator is\n>  \tseen, stop reading commits and start reading paths to limit the\n> @@ -197,36 +172,32 @@ endif::git-rev-list[]\n>  \n>  ifdef::git-rev-list[]\n>  --quiet::\n> -\n>  \tDon't print anything to standard output.  This form\n>  \tis primarily meant to allow the caller to\n>  \ttest the exit status to see if a range of objects is fully\n>  \tconnected (or not).  It is faster than redirecting stdout\n> -\tto /dev/null as the output does not have to be formatted.\n> +\tto `/dev/null` as the output does not have to be formatted.\n>  endif::git-rev-list[]\n>  \n>  --cherry-mark::\n> -\n>  \tLike `--cherry-pick` (see below) but mark equivalent commits\n>  \twith `=` rather than omitting them, and inequivalent ones with `+`.\n>  \n>  --cherry-pick::\n> -\n>  \tOmit any commit that introduces the same change as\n> -\tanother commit on the \"other side\" when the set of\n> +\tanother commit on the ``other side'' when the set of\n>  \tcommits are limited with symmetric difference.\n>  +\n>  For example, if you have two branches, `A` and `B`, a usual way\n>  to list all commits on only one side of them is with\n>  `--left-right` (see the example below in the description of\n>  the `--left-right` option).  It however shows the commits that were cherry-picked\n> -from the other branch (for example, \"3rd on b\" may be cherry-picked\n> +from the other branch (for example, ``3rd on b'' may be cherry-picked\n>  from branch A).  With this option, such pairs of commits are\n>  excluded from the output.\n>  \n>  --left-only::\n>  --right-only::\n> -\n>  \tList only commits on the respective side of a symmetric range,\n>  \ti.e. only those which would be marked `<` resp. `>` by\n>  \t`--left-right`.\n> @@ -238,7 +209,6 @@ More precisely, `--cherry-pick --right-only --no-merges` gives the exact\n>  list.\n>  \n>  --cherry::\n> -\n>  \tA synonym for `--right-only --cherry-mark --no-merges`; useful to\n>  \tlimit the output to the commits on our side and mark those that\n>  \thave been applied to the other side of a forked history with\n> @@ -247,30 +217,27 @@ list.\n>  \n>  -g::\n>  --walk-reflogs::\n> -\n>  \tInstead of walking the commit ancestry chain, walk\n>  \treflog entries from the most recent one to older ones.\n>  \tWhen this option is used you cannot specify commits to\n>  \texclude (that is, '{caret}commit', 'commit1..commit2',\n>  \tnor 'commit1\\...commit2' notations cannot be used).\n>  +\n> -With '\\--pretty' format other than oneline (for obvious reasons),\n> +With `--pretty` format other than `oneline` (for obvious reasons),\n>  this causes the output to have two extra lines of information\n>  taken from the reflog.  By default, 'commit@\\{Nth}' notation is\n>  used in the output.  When the starting commit is specified as\n>  'commit@\\{now}', output also uses 'commit@\\{timestamp}' notation\n> -instead.  Under '\\--pretty=oneline', the commit message is\n> +instead.  Under `--pretty=oneline`, the commit message is\n>  prefixed with this information on the same line.\n> -This option cannot be combined with '\\--reverse'.\n> +This option cannot be combined with `--reverse`.\n>  See also linkgit:git-reflog[1].\n>  \n>  --merge::\n> -\n>  \tAfter a failed merge, show refs that touch files having a\n>  \tconflict and don't exist on all heads to merge.\n>  \n>  --boundary::\n> -\n>  \tOutput excluded boundary commits. Boundary commits are\n>  \tprefixed with `-`.\n>  \n> @@ -287,11 +254,9 @@ is how to do it, as there are various strategies to simplify the history.\n>  The following options select the commits to be shown:\n>  \n>  <paths>::\n> -\n>  \tCommits modifying the given <paths> are selected.\n>  \n>  --simplify-by-decoration::\n> -\n>  \tCommits that are referred by some branch or tag are selected.\n>  \n>  Note that extra commits can be shown to give a meaningful history.\n> @@ -299,33 +264,27 @@ Note that extra commits can be shown to give a meaningful history.\n>  The following options affect the way the simplification is performed:\n>  \n>  Default mode::\n> -\n>  \tSimplifies the history to the simplest history explaining the\n>  \tfinal state of the tree. Simplest because it prunes some side\n>  \tbranches if the end result is the same (i.e. merging branches\n>  \twith the same content)\n>  \n>  --full-history::\n> -\n>  \tSame as the default mode, but does not prune some history.\n>  \n>  --dense::\n> -\n>  \tOnly the selected commits are shown, plus some to have a\n>  \tmeaningful history.\n>  \n>  --sparse::\n> -\n>  \tAll commits in the simplified history are shown.\n>  \n>  --simplify-merges::\n> -\n> -\tAdditional option to '--full-history' to remove some needless\n> +\tAdditional option to `--full-history` to remove some needless\n>  \tmerges from the resulting history, as there are no selected\n>  \tcommits contributing to this merge.\n>  \n>  --ancestry-path::\n> -\n>  \tWhen given a range of commits to display (e.g. 'commit1..commit2'\n>  \tor 'commit2 {caret}commit1'), only display commits that exist\n>  \tdirectly on the ancestry chain between the 'commit1' and\n> @@ -352,36 +311,35 @@ The horizontal line of history A---Q is taken to be the first parent of\n>  each merge.  The commits are:\n>  \n>  * `I` is the initial commit, in which `foo` exists with contents\n> -  \"asdf\", and a file `quux` exists with contents \"quux\".  Initial\n> +  ``asdf'', and a file `quux` exists with contents ``quux''. Initial\n>    commits are compared to an empty tree, so `I` is !TREESAME.\n>  \n> -* In `A`, `foo` contains just \"foo\".\n> +* In `A`, `foo` contains just ``foo''.\n>  \n>  * `B` contains the same change as `A`.  Its merge `M` is trivial and\n>    hence TREESAME to all parents.\n>  \n> -* `C` does not change `foo`, but its merge `N` changes it to \"foobar\",\n> +* `C` does not change `foo`, but its merge `N` changes it to ``foobar'',\n>    so it is not TREESAME to any parent.\n>  \n> -* `D` sets `foo` to \"baz\".  Its merge `O` combines the strings from\n> -  `N` and `D` to \"foobarbaz\"; i.e., it is not TREESAME to any parent.\n> +* `D` sets `foo` to ``baz''. Its merge `O` combines the strings from\n> +  `N` and `D` to ``foobarbaz''; i.e., it is not TREESAME to any parent.\n>  \n> -* `E` changes `quux` to \"xyzzy\", and its merge `P` combines the\n> -  strings to \"quux xyzzy\".  `P` is TREESAME to `O`, but not to `E`.\n> +* `E` changes `quux` to ``xyzzy'', and its merge `P` combines the\n> +  strings to ``quux xyzzy''. `P` is TREESAME to `O`, but not to `E`.\n>  \n>  * `X` is an independent root commit that added a new file `side`, and `Y`\n>    modified it. `Y` is TREESAME to `X`. Its merge `Q` added `side` to `P`, and\n>    `Q` is TREESAME to `P`, but not to `Y`.\n>  \n> -'rev-list' walks backwards through history, including or excluding\n> -commits based on whether '\\--full-history' and/or parent rewriting\n> -(via '\\--parents' or '\\--children') are used.  The following settings\n> +`rev-list` walks backwards through history, including or excluding\n> +commits based on whether `--full-history` and/or parent rewriting\n> +(via `--parents` or `--children`) are used. The following settings\n>  are available.\n>  \n>  Default mode::\n> -\n>  \tCommits are included if they are not TREESAME to any parent\n> -\t(though this can be changed, see '\\--sparse' below).  If the\n> +\t(though this can be changed, see `--sparse` below).  If the\n>  \tcommit was a merge, and it was TREESAME to one parent, follow\n>  \tonly that parent.  (Even if there are several TREESAME\n>  \tparents, follow only one of them.)  Otherwise, follow all\n> @@ -400,12 +358,11 @@ available, removed `B` from consideration entirely.  `C` was\n>  considered via `N`, but is TREESAME.  Root commits are compared to an\n>  empty tree, so `I` is !TREESAME.\n>  +\n> -Parent/child relations are only visible with --parents, but that does\n> +Parent/child relations are only visible with `--parents`, but that does\n>  not affect the commits selected in default mode, so we have shown the\n>  parent lines.\n>  \n>  --full-history without parent rewriting::\n> -\n>  \tThis mode differs from the default in one point: always follow\n>  \tall parents of a merge, even if it is TREESAME to one of them.\n>  \tEven if more than one side of the merge has commits that are\n> @@ -425,9 +382,8 @@ about the parent/child relationships between the commits, so we show\n>  them disconnected.\n>  \n>  --full-history with parent rewriting::\n> -\n>  \tOrdinary commits are only included if they are !TREESAME\n> -\t(though this can be changed, see '\\--sparse' below).\n> +\t(though this can be changed, see `--sparse` below).\n>  +\n>  Merges are always included.  However, their parent list is rewritten:\n>  Along each parent, prune away commits that are not included\n> @@ -441,7 +397,7 @@ themselves.  This results in\n>  \t  `-------------'\n>  -----------------------------------------------------------------------\n>  +\n> -Compare to '\\--full-history' without rewriting above.  Note that `E`\n> +Compare to `--full-history` without rewriting above.  Note that `E`\n>  was pruned away because it is TREESAME, but the parent list of P was\n>  rewritten to contain `E`'s parent `I`.  The same happened for `C` and\n>  `N`, and `X`, `Y` and `Q`.\n> @@ -450,22 +406,19 @@ In addition to the above settings, you can change whether TREESAME\n>  affects inclusion:\n>  \n>  --dense::\n> -\n>  \tCommits that are walked are included if they are not TREESAME\n>  \tto any parent.\n>  \n>  --sparse::\n> -\n>  \tAll commits that are walked are included.\n>  +\n> -Note that without '\\--full-history', this still simplifies merges: if\n> +Note that without `--full-history`, this still simplifies merges: if\n>  one of the parents is TREESAME, we follow only that one, so the other\n>  sides of the merge are never walked.\n>  \n>  --simplify-merges::\n> -\n>  \tFirst, build a history graph in the same way that\n> -\t'\\--full-history' with parent rewriting does (see above).\n> +\t`--full-history` with parent rewriting does (see above).\n>  +\n>  Then simplify each commit `C` to its replacement `C'` in the final\n>  history according to the following rules:\n> @@ -484,7 +437,7 @@ history according to the following rules:\n>  --\n>  +\n>  The effect of this is best shown by way of comparing to\n> -'\\--full-history' with parent rewriting.  The example turns into:\n> +`--full-history` with parent rewriting.  The example turns into:\n>  +\n>  -----------------------------------------------------------------------\n>  \t  .-A---M---N---O\n> @@ -494,7 +447,7 @@ The effect of this is best shown by way of comparing to\n>  \t  `---------'\n>  -----------------------------------------------------------------------\n>  +\n> -Note the major differences in `N`, `P` and `Q` over '--full-history':\n> +Note the major differences in `N`, `P` and `Q` over `--full-history`:\n>  +\n>  --\n>  * `N`'s parent list had `I` removed, because it is an ancestor of the\n> @@ -511,11 +464,10 @@ Note the major differences in `N`, `P` and `Q` over '--full-history':\n>  Finally, there is a fifth simplification mode available:\n>  \n>  --ancestry-path::\n> -\n>  \tLimit the displayed commits to those directly on the ancestry\n> -\tchain between the \"from\" and \"to\" commits in the given commit\n> -\trange. I.e. only display commits that are ancestor of the \"to\"\n> -\tcommit, and descendants of the \"from\" commit.\n> +\tchain between the ``from'' and ``to'' commits in the given commit\n> +\trange. I.e. only display commits that are ancestor of the ``to''\n> +\tcommit, and descendants of the ``from'' commit.\n>  +\n>  As an example use case, consider the following commit history:\n>  +\n> @@ -530,14 +482,14 @@ As an example use case, consider the following commit history:\n>  A regular 'D..M' computes the set of commits that are ancestors of `M`,\n>  but excludes the ones that are ancestors of `D`. This is useful to see\n>  what happened to the history leading to `M` since `D`, in the sense\n> -that \"what does `M` have that did not exist in `D`\". The result in this\n> +that ``what does `M` have that did not exist in `D`''. The result in this\n>  example would be all the commits, except `A` and `B` (and `D` itself,\n>  of course).\n>  +\n>  When we want to find out what commits in `M` are contaminated with the\n>  bug introduced by `D` and need fixing, however, we might want to view\n>  only the subset of 'D..M' that are actually descendants of `D`, i.e.\n> -excluding `C` and `K`. This is exactly what the '--ancestry-path'\n> +excluding `C` and `K`. This is exactly what the `--ancestry-path`\n>  option does. Applied to the 'D..M' range, it results in:\n>  +\n>  -----------------------------------------------------------------------\n> @@ -548,7 +500,7 @@ option does. Applied to the 'D..M' range, it results in:\n>  \t\t\t\tL--M\n>  -----------------------------------------------------------------------\n>  \n> -The '\\--simplify-by-decoration' option allows you to view only the\n> +The `--simplify-by-decoration` option allows you to view only the\n>  big picture of the topology of the history, by omitting commits\n>  that are not referenced by tags.  Commits are marked as !TREESAME\n>  (in other words, kept after history simplification rules described\n> @@ -561,50 +513,47 @@ Bisection Helpers\n>  ~~~~~~~~~~~~~~~~~\n>  \n>  --bisect::\n> -\n> -Limit output to the one commit object which is roughly halfway between\n> -included and excluded commits. Note that the bad bisection ref\n> -`refs/bisect/bad` is added to the included commits (if it\n> -exists) and the good bisection refs `refs/bisect/good-*` are\n> -added to the excluded commits (if they exist). Thus, supposing there\n> -are no refs in `refs/bisect/`, if\n> -\n> +\tLimit output to the one commit object which is roughly halfway between\n> +\tincluded and excluded commits. Note that the bad bisection ref\n> +\t`refs/bisect/bad` is added to the included commits (if it\n> +\texists) and the good bisection refs `refs/bisect/good-*` are\n> +\tadded to the excluded commits (if they exist). Thus, supposing there\n> +\tare no refs in `refs/bisect/`, if\n> ++\n>  -----------------------------------------------------------------------\n>  \t$ git rev-list --bisect foo ^bar ^baz\n>  -----------------------------------------------------------------------\n> -\n> ++\n>  outputs 'midpoint', the output of the two commands\n> -\n> ++\n>  -----------------------------------------------------------------------\n>  \t$ git rev-list foo ^midpoint\n>  \t$ git rev-list midpoint ^bar ^baz\n>  -----------------------------------------------------------------------\n> -\n> ++\n>  would be of roughly the same length.  Finding the change which\n>  introduces a regression is thus reduced to a binary search: repeatedly\n>  generate and test new 'midpoint's until the commit chain is of length\n>  one.\n>  \n>  --bisect-vars::\n> -\n> -This calculates the same as `--bisect`, except that refs in\n> -`refs/bisect/` are not used, and except that this outputs\n> -text ready to be eval'ed by the shell. These lines will assign the\n> -name of the midpoint revision to the variable `bisect_rev`, and the\n> -expected number of commits to be tested after `bisect_rev` is tested\n> -to `bisect_nr`, the expected number of commits to be tested if\n> -`bisect_rev` turns out to be good to `bisect_good`, the expected\n> -number of commits to be tested if `bisect_rev` turns out to be bad to\n> -`bisect_bad`, and the number of commits we are bisecting right now to\n> -`bisect_all`.\n> +\tThis calculates the same as `--bisect`, except that refs in\n> +\t`refs/bisect/` are not used, and except that this outputs\n> +\ttext ready to be eval'ed by the shell. These lines will assign the\n> +\tname of the midpoint revision to the variable `bisect_rev`, and the\n> +\texpected number of commits to be tested after `bisect_rev` is tested\n> +\tto `bisect_nr`, the expected number of commits to be tested if\n> +\t`bisect_rev` turns out to be good to `bisect_good`, the expected\n> +\tnumber of commits to be tested if `bisect_rev` turns out to be bad to\n> +\t`bisect_bad`, and the number of commits we are bisecting right now to\n> +\t`bisect_all`.\n>  \n>  --bisect-all::\n> -\n> -This outputs all the commit objects between the included and excluded\n> -commits, ordered by their distance to the included and excluded\n> -commits. Refs in `refs/bisect/` are not used. The farthest\n> -from them is displayed first. (This is the only one displayed by\n> -`--bisect`.)\n> +\tThis outputs all the commit objects between the included and excluded\n> +\tcommits, ordered by their distance to the included and excluded\n> +\tcommits. Refs in `refs/bisect/` are not used. The farthest\n> +\tfrom them is displayed first. (This is the only one displayed by\n> +\t`--bisect`.)\n>  +\n>  This is useful because it makes it easy to choose a good commit to\n>  test when you want to avoid to test some of them for some reason (they\n> @@ -654,9 +603,8 @@ avoid showing the commits from two parallel development track mixed\n>  together.\n>  \n>  --reverse::\n> -\n>  \tOutput the commits in reverse order.\n> -\tCannot be combined with '\\--walk-reflogs'.\n> +\tCannot be combined with `--walk-reflogs`.\n>  \n>  Object Traversal\n>  ~~~~~~~~~~~~~~~~\n> @@ -664,37 +612,32 @@ Object Traversal\n>  These options are mostly targeted for packing of Git repositories.\n>  \n>  --objects::\n> -\n>  \tPrint the object IDs of any object referenced by the listed\n> -\tcommits.  '--objects foo ^bar' thus means \"send me\n> +\tcommits.  `--objects foo ^bar` thus means ``send me\n>  \tall object IDs which I need to download if I have the commit\n> -\tobject 'bar', but not 'foo'\".\n> +\tobject _bar_ but not _foo_''.\n>  \n>  --objects-edge::\n> -\n> -\tSimilar to '--objects', but also print the IDs of excluded\n> -\tcommits prefixed with a \"-\" character.  This is used by\n> -\tlinkgit:git-pack-objects[1] to build \"thin\" pack, which records\n> +\tSimilar to `--objects`, but also print the IDs of excluded\n> +\tcommits prefixed with a ``-'' character.  This is used by\n> +\tlinkgit:git-pack-objects[1] to build ``thin'' pack, which records\n>  \tobjects in deltified form based on objects contained in these\n>  \texcluded commits to reduce network traffic.\n>  \n>  --unpacked::\n> -\n> -\tOnly useful with '--objects'; print the object IDs that are not\n> +\tOnly useful with `--objects`; print the object IDs that are not\n>  \tin packs.\n>  \n>  --no-walk[=(sorted|unsorted)]::\n> -\n>  \tOnly show the given commits, but do not traverse their ancestors.\n>  \tThis has no effect if a range is specified. If the argument\n> -\t\"unsorted\" is given, the commits are show in the order they were\n> -\tgiven on the command line. Otherwise (if \"sorted\" or no argument\n> +\t`unsorted` is given, the commits are show in the order they were\n> +\tgiven on the command line. Otherwise (if `sorted` or no argument\n>  \twas given), the commits are show in reverse chronological order\n>  \tby commit time.\n>  \n>  --do-walk::\n> -\n> -\tOverrides a previous --no-walk.\n> +\tOverrides a previous `--no-walk`.\n>  \n>  Commit Formatting\n>  ~~~~~~~~~~~~~~~~~\n> @@ -708,17 +651,15 @@ endif::git-rev-list[]\n>  include::pretty-options.txt[]\n>  \n>  --relative-date::\n> -\n>  \tSynonym for `--date=relative`.\n>  \n>  --date=(relative|local|default|iso|rfc|short|raw)::\n> -\n>  \tOnly takes effect for dates shown in human-readable format, such\n> -\tas when using \"--pretty\". `log.date` config variable sets a default\n> -\tvalue for log command's --date option.\n> +\tas when using `--pretty`. `log.date` config variable sets a default\n> +\tvalue for log command's `--date` option.\n>  +\n>  `--date=relative` shows dates relative to the current time,\n> -e.g. \"2 hours ago\".\n> +e.g. ``2 hours ago''.\n>  +\n>  `--date=local` shows timestamps in user's local time zone.\n>  +\n> @@ -736,18 +677,15 @@ format, often found in E-mail messages.\n>  \n>  ifdef::git-rev-list[]\n>  --header::\n> -\n>  \tPrint the contents of the commit in raw-format; each record is\n>  \tseparated with a NUL character.\n>  endif::git-rev-list[]\n>  \n>  --parents::\n> -\n>  \tPrint also the parents of the commit (in the form \"commit parent...\").\n>  \tAlso enables parent rewriting, see 'History Simplification' below.\n>  \n>  --children::\n> -\n>  \tPrint also the children of the commit (in the form \"commit child...\").\n>  \tAlso enables parent rewriting, see 'History Simplification' below.\n>  \n> @@ -757,7 +695,6 @@ ifdef::git-rev-list[]\n>  endif::git-rev-list[]\n>  \n>  --left-right::\n> -\n>  \tMark which side of a symmetric diff a commit is reachable from.\n>  \tCommits from the left side are prefixed with `<` and those from\n>  \tthe right with `>`.  If combined with `--boundary`, those\n> @@ -787,7 +724,6 @@ you would get an output like this:\n>  -----------------------------------------------------------------------\n>  \n>  --graph::\n> -\n>  \tDraw a text-based graphical representation of the commit history\n>  \ton the left hand side of the output.  This may cause extra lines\n>  \tto be printed in between commits, in order for the graph history\n> @@ -795,21 +731,20 @@ you would get an output like this:\n>  +\n>  This enables parent rewriting, see 'History Simplification' below.\n>  +\n> -This implies the '--topo-order' option by default, but the\n> -'--date-order' option may also be specified.\n> +This implies the `--topo-order` option by default, but the\n> +`--date-order` option may also be specified.\n>  \n>  ifdef::git-rev-list[]\n>  --count::\n>  \tPrint a number stating how many commits would have been\n>  \tlisted, and suppress all other output.  When used together\n> -\twith '--left-right', instead print the counts for left and\n> +\twith `--left-right`, instead print the counts for left and\n>  \tright commits, separated by a tab. When used together with\n> -\t'--cherry-mark', omit patch equivalent commits from these\n> +\t`--cherry-mark`, omit patch equivalent commits from these\n>  \tcounts and print the count for equivalent commits separated\n>  \tby a tab.\n>  endif::git-rev-list[]\n>  \n> -\n>  ifndef::git-rev-list[]\n>  Diff Formatting\n>  ~~~~~~~~~~~~~~~\n> @@ -819,7 +754,6 @@ Some of them are specific to linkgit:git-rev-list[1], however other diff\n>  options may be given. See linkgit:git-diff-files[1] for more options.\n>  \n>  -c::\n> -\n>  \tWith this option, diff output for a merge commit\n>  \tshows the differences from each of the parents to the merge result\n>  \tsimultaneously instead of showing pairwise diff between a parent\n> @@ -827,26 +761,22 @@ options may be given. See linkgit:git-diff-files[1] for more options.\n>  \twhich were modified from all parents.\n>  \n>  --cc::\n> -\n> -\tThis flag implies the '-c' option and further compresses the\n> +\tThis flag implies the `-c` option and further compresses the\n>  \tpatch output by omitting uninteresting hunks whose contents in\n>  \tthe parents have only two variants and the merge result picks\n>  \tone of them without modification.\n>  \n>  -m::\n> -\n>  \tThis flag makes the merge commits show the full diff like\n>  \tregular commits; for each merge parent, a separate log entry\n>  \tand diff is generated. An exception is that only diff against\n> -\tthe first parent is shown when '--first-parent' option is given;\n> +\tthe first parent is shown when `--first-parent` option is given;\n>  \tin that case, the output represents the changes the merge\n>  \tbrought _into_ the then-current branch.\n>  \n>  -r::\n> -\n>  \tShow recursive diffs.\n>  \n>  -t::\n> -\n> -\tShow the tree objects in the diff output. This implies '-r'.\n> +\tShow the tree objects in the diff output. This implies `-r`.\n>  endif::git-rev-list[]\n"}]}