{"thread":{"id":"35311","subject":"[PATCH 2/4] Emphasize options and force ASCIIDOC escaping of \"--\"","startedAt":"2013-11-09T00:48:51Z","lastAt":"2013-11-12T18:40:31Z","messageCount":8,"participants":["Jason St. John","Jonathan Nieder","Johannes Sixt","Junio C Hamano","Jeff King"],"isPatch":true,"patchVersion":1,"patchTotal":4},"messages":[{"id":"230259","messageId":"1383958133-4207-1-git-send-email-jstjohn@purdue.edu","threadId":"35311","inReplyTo":null,"subject":"[PATCH 2/4] Emphasize options and force ASCIIDOC escaping of \"--\"","fromName":"Jason St. John","fromEmail":"jstjohn@purdue.edu","sentAt":"2013-11-09T00:48:51Z","receivedAt":"2013-11-09T00:48:51Z","isPatch":true,"sender":{"key":"jstjohn@purdue.edu","avatar":"https://avatars.githubusercontent.com/u/1393510?v=4"},"body":"rev-list-options.txt: replace e.g. `--foo` with '\\--foo'\nrev-list-options.txt: emphasize, instead of quote, some option arguments\n (e.g. \"foo-option\" becomes 'foo-option')\nrev-list-options.txt: force ASCIIDOC escaping of \"--\" (e.g. '--bar'\n becomes '\\--bar')\nrev-list-options.txt: add single quote chars around options missing them\n (e.g. --grep becomes '\\--grep')\nrev-list-options.txt: replaced one instance of \"regexp\" with \"regular\n expressions\"\nrev-list-options.txt: fix typo in \"--no-walk\" description (\"show\" -->\n\"shown\")\nrev-list-options.txt: replaced some instances of double quotes with\n their ASCIIDOC equivalent (e.g. \"\"\"a \"-\" character\"\"\" becomes\n \"\"\"a ``-'' character\"\"\",\n\nSigned-off-by: Jason St. John \n---\nSorry for the messy quoting in the last set of examples in the commit message.\nThere wasn't really any way to work around it other than omitting the quotes\naround the before and after parts, which I didn't want to do.\n\n\n Documentation/rev-list-options.txt | 136 ++++++++++++++++++-------------------\n 1 file changed, 68 insertions(+), 68 deletions(-)\n\ndiff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt\nindex 5bdfb42..32c40ae 100644\n--- a/Documentation/rev-list-options.txt\n+++ b/Documentation/rev-list-options.txt\n@@ -6,12 +6,12 @@ special notations explained in the description, additional commit\n limiting may be applied.\n \n Using more options generally further limits the output (e.g.\n-`--since=` limits to commits newer than ``, and using it\n-with `--grep=` further limits to commits whose log message\n+'\\--since=' limits to commits newer than ``, and using it\n+with '\\--grep=' further limits to commits whose log message\n has a line that matches ``), unless otherwise noted.\n \n Note that these are applied before commit\n-ordering and formatting options, such as `--reverse`.\n+ordering and formatting options, such as '\\--reverse'.\n \n --\n \n@@ -47,31 +47,31 @@ endif::git-rev-list[]\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=`,\n+\texpression). With more than one '\\--author=',\n \tcommits whose author matches any of the given patterns are\n-\tchosen (similarly for multiple `--committer=`).\n+\tchosen (similarly for multiple '\\--committer=').\n \n --grep-reflog=::\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+\tmore than one '\\--grep-reflog', commits whose reflog message\n \tmatches any of the given patterns are chosen. It is an\n-\terror to use this option unless `--walk-reflogs` is in use.\n+\terror to use this option unless '\\--walk-reflogs' is in use.\n \n --grep=::\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=`, commits whose message\n+\tmore than one '\\--grep=', commits whose message\n \tmatches any of the given patterns are chosen (but see\n-\t`--all-match`).\n+\t'\\--all-match').\n +\n-When `--show-notes` is in effect, the message from the notes as\n+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@@ -98,7 +98,7 @@ if it is part of the log message.\n \n --perl-regexp::\n \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@@ -107,12 +107,12 @@ if it is part of the log message.\n \n --merges::\n \n-\tPrint only merge commits. This is exactly the same as `--min-parents=2`.\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+\texactly the same as '\\--max-parents=1'.\n \n --min-parents=::\n --max-parents=::\n@@ -120,13 +120,13 @@ if it is part of the log message.\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-\tgives all root commits and `--min-parents=3` all octopus merges.\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+\tgives all root commits and '\\--min-parents=3' all octopus merges.\n +\n-`--no-min-parents` and `--no-max-parents` reset these limits (to no limit)\n-again. Equivalent forms are `--min-parents=0` (any commit has 0 or more\n-parents) and `--max-parents=-1` (negative numbers denote no upper limit).\n+'\\--no-min-parents' and '\\--no-max-parents' reset these limits (to no limit)\n+again. Equivalent forms are '\\--min-parents=0' (any commit has 0 or more\n+parents) and '\\--max-parents=-1' (negative numbers denote no upper limit).\n \n --first-parent::\n \tFollow only the first parent commit upon seeing a merge\n@@ -140,7 +140,7 @@ parents) and `--max-parents=-1` (negative numbers denote no upper limit).\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@@ -183,7 +183,7 @@ 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+\twas listed and as if it was followed by '\\--not' and the good\n \tbisection refs `refs/bisect/good-*` on the command\n \tline.\n endif::git-rev-list[]\n@@ -207,7 +207,7 @@ endif::git-rev-list[]\n \n --cherry-mark::\n \n-\tLike `--cherry-pick` (see below) but mark equivalent commits\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@@ -218,8 +218,8 @@ endif::git-rev-list[]\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+'\\--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 excluded from the output.\n@@ -229,21 +229,21 @@ excluded from the output.\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+\t'\\--left-right'.\n +\n-For example, `--cherry-pick --right-only A...B` omits those\n+For example, '\\--cherry-pick \\--right-only A...B' omits those\n commits from `B` which are in `A` or are patch-equivalent to a commit in\n `A`. In other words, this lists the `+` commits from `git cherry A B`.\n-More precisely, `--cherry-pick --right-only --no-merges` gives the exact\n+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+\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-\t`git log --cherry upstream...mybranch`, similar to\n-\t`git cherry upstream mybranch`.\n+\t'git log \\--cherry upstream...mybranch', similar to\n+\t'git cherry upstream mybranch'.\n \n -g::\n --walk-reflogs::\n@@ -254,7 +254,7 @@ list.\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@@ -320,7 +320,7 @@ Default mode::\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@@ -400,7 +400,7 @@ 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@@ -494,7 +494,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@@ -537,7 +537,7 @@ of course).\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@@ -587,7 +587,7 @@ one.\n \n --bisect-vars::\n \n-This calculates the same as `--bisect`, except that refs in\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@@ -604,15 +604,15 @@ 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+'\\--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 may not compile for example).\n +\n-This option can be used along with `--bisect-vars`, in this case,\n+This option can be used along with '\\--bisect-vars', in this case,\n after all the sorted commit objects, there will be the same text as if\n-`--bisect-vars` had been used alone.\n+'\\--bisect-vars' had been used alone.\n endif::git-rev-list[]\n \n \n@@ -645,10 +645,10 @@ For example, in a commit history like this:\n ----------------------------------------------------------------\n +\n where the numbers denote the order of commit timestamps, `git\n-rev-list` and friends with `--date-order` show the commits in the\n+rev-list` and friends with '\\--date-order' show the commits in the\n timestamp order: 8 7 6 5 4 3 2 1.\n +\n-With `--topo-order`, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5\n+With '\\--topo-order', they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5\n 3 1); some older commits are shown before newer ones in order to\n avoid showing the commits from two parallel development track mixed\n together.\n@@ -666,35 +666,35 @@ These options are mostly targeted for packing of Git repositories.\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 \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-\twas given), the commits are show in reverse chronological order\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 shown 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@@ -709,29 +709,29 @@ include::pretty-options.txt[]\n \n --relative-date::\n \n-\tSynonym for `--date=relative`.\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'. The `log.date` config variable sets a\n+\tdefault value for the log command's '\\--date' option.\n +\n-`--date=relative` shows dates relative to the current time,\n+'\\--date=relative' shows dates relative to the current time,\n e.g. \"2 hours ago\".\n +\n-`--date=local` shows timestamps in user's local timezone.\n+'\\--date=local' shows timestamps in user's local timezone.\n +\n-`--date=iso` (or `--date=iso8601`) shows timestamps in ISO 8601 format.\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+'\\--date=rfc' (or '\\--date=rfc2822') shows timestamps in RFC 2822\n format, often found in E-mail 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+'\\--date=raw' shows the date in the internal raw Git format `%s %z` format.\n +\n-`--date=default` shows timestamps in the original timezone\n+'\\--date=default' shows timestamps in the original timezone\n (either committer's or author's).\n \n ifdef::git-rev-list[]\n@@ -760,8 +760,8 @@ endif::git-rev-list[]\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-\tcommits are prefixed with `-`.\n+\tthe right with `>`. If combined with '\\--boundary', those\n+\tcommits are prefixed with ``-''.\n +\n For example, if you have this topology:\n +\n@@ -795,16 +795,16 @@ 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@@ -838,7 +838,7 @@ options may be given. See linkgit:git-diff-files[1] for more options.\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-- \n1.8.4.2\n"},{"id":"230261","messageId":"1383958133-4207-2-git-send-email-jstjohn@purdue.edu","threadId":"35311","inReplyTo":"1383958133-4207-1-git-send-email-jstjohn@purdue.edu","subject":"[PATCH 3/4] Correct word usage of \"timezone\" in \"Documentation\" directory","fromName":"Jason St. John","fromEmail":"jstjohn@purdue.edu","sentAt":"2013-11-09T00:48:52Z","receivedAt":"2013-11-09T00:48:52Z","isPatch":true,"sender":{"key":"jstjohn@purdue.edu","avatar":"https://avatars.githubusercontent.com/u/1393510?v=4"},"body":"\"timezone\" is two words, not one (i.e. \"time zone\" is correct).\n\nCorrect this in these files:\n-- date-formats.txt\n-- git-blame.txt\n-- git-cvsimport.txt\n-- git-fast-import.txt\n-- git-svn.txt\n-- gitweb.conf.txt\n-- rev-list-options.txt\n\nSigned-off-by: Jason St. John \n---\nSources:\n(1) https://en.wikipedia.org/wiki/Time_zone\n(2) https://www.google.com/trends/explore?q=%22timezone%22+%22time+zone%22#q=timezone%2C%20time%20zone&cmpt=q\n(3) A search of Google Scholar (non-patent articles) for each term:\n\t\t\"timezone\": 8,300 results\n\t\t\"time zone\": 40,100 results\n\n\n Documentation/date-formats.txt | 4 ++--\n Documentation/git-blame.txt | 2 +-\n Documentation/git-cvsimport.txt | 4 ++--\n Documentation/git-fast-import.txt | 10 +++++-----\n Documentation/git-svn.txt | 6 +++---\n Documentation/gitweb.conf.txt | 14 +++++++-------\n Documentation/rev-list-options.txt | 4 ++--\n 7 files changed, 22 insertions(+), 22 deletions(-)\n\ndiff --git a/Documentation/date-formats.txt b/Documentation/date-formats.txt\nindex c000f08..ccd1fc8 100644\n--- a/Documentation/date-formats.txt\n+++ b/Documentation/date-formats.txt\n@@ -8,9 +8,9 @@ endif::git-commit[]\n support the following date formats:\n \n Git internal format::\n-\tIt is ` `, where `