{"thread":{"id":"22241","subject":"[PATCH] Fix bad quoting in documentation","startedAt":"2010-01-16T08:02:16Z","lastAt":"2010-01-16T11:58:59Z","messageCount":4,"participants":["Ramkumar Ramachandra","Thomas Rast","Teemu Likonen"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"131856","messageId":"f3271551001160002r25cb0ac7hc96891f4af22bd03@mail.gmail.com","threadId":"22241","inReplyTo":null,"subject":"[PATCH] Fix bad quoting in documentation","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2010-01-16T08:02:16Z","receivedAt":"2010-01-16T08:02:16Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"Reported by Frédéric Brière <fbriere@fbriere.net> through\nhttp://bugs.debian.org/540001\n\nSigned-off-by: Ramkumar Ramachandra <artagnon@gmail.com>\n---\n Documentation/diff-options.txt      |    2 +-\n Documentation/git-add.txt           |    4 ++--\n Documentation/git-bundle.txt        |    8 ++++----\n Documentation/git-checkout.txt      |    4 ++--\n Documentation/git-filter-branch.txt |   30 +++++++++++++++---------------\n Documentation/git-format-patch.txt  |    4 ++--\n Documentation/git-rebase.txt        |    8 ++++----\n Documentation/git-reflog.txt        |    6 +++---\n Documentation/git-rev-parse.txt     |   24 ++++++++++++------------\n Documentation/git-rm.txt            |    6 +++---\n 10 files changed, 48 insertions(+), 48 deletions(-)\n\ndiff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt\nindex 8707d0e..6f3c115 100644\n--- a/Documentation/diff-options.txt\n+++ b/Documentation/diff-options.txt\n@@ -54,7 +54,7 @@ endif::git-format-patch[]\n \tgiving another width to it separated by a comma.\n\n --numstat::\n-\tSimilar to `\\--stat`, but shows number of added and\n+\tSimilar to `--stat`, but shows number of added and\n \tdeleted lines in decimal notation and pathname without\n \tabbreviation, to make it more machine friendly.  For\n \tbinary files, outputs two `-` instead of saying\ndiff --git a/Documentation/git-add.txt b/Documentation/git-add.txt\nindex 1f1b199..838ad6f 100644\n--- a/Documentation/git-add.txt\n+++ b/Documentation/git-add.txt\n@@ -149,14 +149,14 @@ those in info/exclude.  See\nlinkgit:gitrepository-layout[5].\n EXAMPLES\n --------\n\n-* Adds content from all `\\*.txt` files under `Documentation` directory\n+* Adds content from all `*.txt` files under `Documentation` directory\n and its subdirectories:\n +\n ------------\n $ git add Documentation/\\\\*.txt\n ------------\n +\n-Note that the asterisk `\\*` is quoted from the shell in this\n+Note that the asterisk `*` is quoted from the shell in this\n example; this lets the command include the files from\n subdirectories of `Documentation/` directory.\n\ndiff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt\nindex c3a066e..ee8722f 100644\n--- a/Documentation/git-bundle.txt\n+++ b/Documentation/git-bundle.txt\n@@ -60,7 +60,7 @@ unbundle <file>::\n [git-rev-list-args...]::\n        A list of arguments, acceptable to 'git-rev-parse' and\n        'git-rev-list', that specifies the specific objects and references\n-       to transport.  For example, `master\\~10..master` causes the\n+       to transport.  For example, `master~10..master` causes the\n        current master reference to be packaged along with all objects\n        added since its 10th ancestor commit.  There is no explicit\n        limit to the number of references and objects that may be\n@@ -79,12 +79,12 @@ SPECIFYING REFERENCES\n\n 'git-bundle' will only package references that are shown by\n 'git-show-ref': this includes heads, tags, and remote heads.  References\n-such as `master\\~1` cannot be packaged, but are perfectly suitable for\n+such as `master~1` cannot be packaged, but are perfectly suitable for\n defining the basis.  More than one reference may be packaged, and more\n than one basis can be specified.  The objects packaged are those not\n contained in the union of the given bases.  Each basis can be\n-specified explicitly (e.g. `^master\\~10`), or implicitly (e.g.\n-`master\\~10..master`, `--since=10.days.ago master`).\n+specified explicitly (e.g. `^master~10`), or implicitly (e.g.\n+`master~10..master`, `--since=10.days.ago master`).\n\n It is very important that the basis used be held by the destination.\n It is okay to err on the side of caution, causing the bundle file\ndiff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt\nindex 37c1810..df27ca5 100644\n--- a/Documentation/git-checkout.txt\n+++ b/Documentation/git-checkout.txt\n@@ -133,9 +133,9 @@ edits from your current working tree.\n \tcommit, your HEAD becomes \"detached\" and you are no longer on\n \tany branch (see below for details).\n +\n-As a special case, the `\"@\\{-N\\}\"` syntax for the N-th last branch\n+As a special case, the '@\\{-N\\}' syntax for the N-th last branch\n checks out the branch (instead of detaching).  You may also specify\n-`-` which is synonymous with `\"@\\{-1\\}\"`.\n+`-` which is synonymous with '@\\{-1\\}'.\n\n <new_branch>::\n \tName for the new branch.\ndiff --git a/Documentation/git-filter-branch.txt\nb/Documentation/git-filter-branch.txt\nindex 394a77a..2fa46cc 100644\n--- a/Documentation/git-filter-branch.txt\n+++ b/Documentation/git-filter-branch.txt\n@@ -95,8 +95,8 @@ OPTIONS\n --index-filter <command>::\n \tThis is the filter for rewriting the index.  It is similar to the\n \ttree filter but does not check out the tree, which makes it much\n-\tfaster.  Frequently used with `git rm \\--cached\n-\t\\--ignore-unmatch ...`, see EXAMPLES below.  For hairy\n+\tfaster.  Frequently used with `git rm --cached\n+\t--ignore-unmatch ...`, see EXAMPLES below.  For hairy\n \tcases, see linkgit:git-update-index[1].\n\n --parent-filter <command>::\n@@ -221,11 +221,11 @@ However, if the file is absent from the tree of\nsome commit,\n a simple `rm filename` will fail for that tree and commit.\n Thus you may instead want to use `rm -f filename` as the script.\n\n-Using `\\--index-filter` with 'git-rm' yields a significantly faster\n+Using `--index-filter` with 'git-rm' yields a significantly faster\n version.  Like with using `rm filename`, `git rm --cached filename`\n will fail if the file is absent from the tree of a commit.  If you\n want to \"completely forget\" a file, it does not matter when it entered\n-history, so we also add `\\--ignore-unmatch`:\n+history, so we also add `--ignore-unmatch`:\n\n --------------------------------------------------------------------------\n git filter-branch --index-filter 'git rm --cached --ignore-unmatch\nfilename' HEAD\n@@ -241,8 +241,8 @@ git filter-branch --subdirectory-filter foodir -- --all\n -------------------------------------------------------\n\n Thus you can, e.g., turn a library subdirectory into a repository of\n-its own.  Note the `\\--` that separates 'filter-branch' options from\n-revision options, and the `\\--all` to rewrite all branches and tags.\n+its own.  Note the `--` that separates 'filter-branch' options from\n+revision options, and the `--all` to rewrite all branches and tags.\n\n To set a commit (which typically is at the tip of another\n history) to be the parent of the current initial commit, in\n@@ -370,18 +370,18 @@ Checklist for Shrinking a Repository\n ------------------------------------\n\n git-filter-branch is often used to get rid of a subset of files,\n-usually with some combination of `\\--index-filter` and\n-`\\--subdirectory-filter`.  People expect the resulting repository to\n+usually with some combination of `--index-filter` and\n+`--subdirectory-filter`.  People expect the resulting repository to\n be smaller than the original, but you need a few more steps to\n actually make it smaller, because git tries hard not to lose your\n objects until you tell it to.  First make sure that:\n\n * You really removed all variants of a filename, if a blob was moved\n-  over its lifetime.  `git log \\--name-only \\--follow \\--all \\--\n+  over its lifetime.  `git log --name-only --follow --all --\n   filename` can help you find renames.\n\n-* You really filtered all refs: use `\\--tag-name-filter cat \\--\n-  \\--all` when calling git-filter-branch.\n+* You really filtered all refs: use `--tag-name-filter cat --\n+  --all` when calling git-filter-branch.\n\n Then there are two ways to get a smaller repository.  A safer way is\n to clone, that keeps your original intact.\n@@ -396,14 +396,14 @@ approach, so *make a backup* or go back to\ncloning it.  You have been\n warned.\n\n * Remove the original refs backed up by git-filter-branch: say `git\n-  for-each-ref \\--format=\"%(refname)\" refs/original/ | xargs -n 1 git\n+  for-each-ref --format=\"%(refname)\" refs/original/ | xargs -n 1 git\n   update-ref -d`.\n\n-* Expire all reflogs with `git reflog expire \\--expire=now \\--all`.\n+* Expire all reflogs with `git reflog expire --expire=now --all`.\n\n-* Garbage collect all unreferenced objects with `git gc \\--prune=now`\n+* Garbage collect all unreferenced objects with `git gc --prune=now`\n   (or if your git-gc is not new enough to support arguments to\n-  `\\--prune`, use `git repack -ad; git prune` instead).\n+  `--prune`, use `git repack -ad; git prune` instead).\n\n\n Author\ndiff --git a/Documentation/git-format-patch.txt\nb/Documentation/git-format-patch.txt\nindex f1fd0df..20d1960 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -44,7 +44,7 @@ There are two ways to specify which commits to operate on.\n The first rule takes precedence in the case of a single <commit>.  To\n apply the second rule, i.e., format everything since the beginning of\n history up until <commit>, use the '\\--root' option: `git format-patch\n-\\--root <commit>`.  If you want to format only <commit> itself, you\n+--root <commit>`.  If you want to format only <commit> itself, you\n can do this with `git format-patch -1 <commit>`.\n\n By default, each output file is numbered sequentially from 1, and uses the\n@@ -133,7 +133,7 @@ include::diff-options.txt[]\n The optional <style> argument can be either `shallow` or `deep`.\n 'shallow' threading makes every mail a reply to the head of the\n series, where the head is chosen from the cover letter, the\n-`\\--in-reply-to`, and the first patch mail, in this order.  'deep'\n+`--in-reply-to`, and the first patch mail, in this order.  'deep'\n threading makes every mail a reply to the previous one.\n +\n The default is `--no-thread`, unless the 'format.thread' configuration\ndiff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt\nindex ca5e1e8..9554c63 100644\n--- a/Documentation/git-rebase.txt\n+++ b/Documentation/git-rebase.txt\n@@ -512,8 +512,8 @@ Easy case: The changes are literally the same.::\n Hard case: The changes are not the same.::\n\n \tThis happens if the 'subsystem' rebase had conflicts, or used\n-\t`\\--interactive` to omit, edit, or squash commits; or if the\n-\tupstream used one of `commit \\--amend`, `reset`, or\n+\t`--interactive` to omit, edit, or squash commits; or if the\n+\tupstream used one of `commit --amend`, `reset`, or\n \t`filter-branch`.\n\n\n@@ -549,7 +549,7 @@ correspond to the ones before the rebase.\n NOTE: While an \"easy case recovery\" sometimes appears to be successful\n       even in the hard case, it may have unintended consequences.  For\n       example, a commit that was removed via `git rebase\n-      \\--interactive` will be **resurrected**!\n+      --interactive` will be **resurrected**!\n\n The idea is to manually tell 'git-rebase' \"where the old 'subsystem'\n ended and your 'topic' began\", that is, what the old merge-base\n@@ -557,7 +557,7 @@ between them was.  You will have to find a way to\nname the last commit\n of the old 'subsystem', for example:\n\n * With the 'subsystem' reflog: after 'git-fetch', the old tip of\n-  'subsystem' is at `subsystem@\\{1}`.  Subsequent fetches will\n+  'subsystem' is at 'subsystem@\\{1\\}'.  Subsequent fetches will\n   increase the number.  (See linkgit:git-reflog[1].)\n\n * Relative to the tip of 'topic': knowing that your 'topic' has three\ndiff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt\nindex 7f7a544..32baa14 100644\n--- a/Documentation/git-reflog.txt\n+++ b/Documentation/git-reflog.txt\n@@ -40,13 +40,13 @@ as well).  It is an alias for `git log -g\n--abbrev-commit --pretty=oneline`;\n see linkgit:git-log[1].\n\n The reflog is useful in various git commands, to specify the old value\n-of a reference. For example, `HEAD@\\{2\\}` means \"where HEAD used to be\n-two moves ago\", `master@\\{one.week.ago\\}` means \"where master used to\n+of a reference. For example, 'HEAD@\\{2\\}' means \"where HEAD used to be\n+two moves ago\", 'master@\\{one.week.ago\\}' means \"where master used to\n point to one week ago\", and so on. See linkgit:git-rev-parse[1] for\n more details.\n\n To delete single entries from the reflog, use the subcommand \"delete\"\n-and specify the _exact_ entry (e.g. \"`git reflog delete master@\\{2\\}`\").\n+and specify the _exact_ entry (e.g. \"`git reflog delete master@{2}`\").\n\n\n OPTIONS\ndiff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt\nindex 82045a2..c332a3c 100644\n--- a/Documentation/git-rev-parse.txt\n+++ b/Documentation/git-rev-parse.txt\n@@ -74,7 +74,7 @@ OPTIONS\n \tproperly quoted for consumption by shell.  Useful when\n \tyou expect your parameter to contain whitespaces and\n \tnewlines (e.g. when using pickaxe `-S` with\n-\t'git-diff-\\*'). In contrast to the `--sq-quote` option,\n+\t'git-diff-*'). In contrast to the `--sq-quote` option,\n \tthe command input is still interpreted as usual.\n\n --not::\n@@ -88,7 +88,7 @@ OPTIONS\n \tform as close to the original input as possible.\n\n --symbolic-full-name::\n-\tThis is similar to \\--symbolic, but it omits input that\n+\tThis is similar to `--symbolic`, but it omits input that\n \tare not refs (i.e. branch or tag names; or more\n \texplicitly disambiguating \"heads/master\" form, when you\n \twant to name the \"master\" branch when there is an\n@@ -246,14 +246,14 @@ when you run 'git-merge'.\n   the usage of this form.\n\n * A suffix '{caret}' followed by an object type name enclosed in\n-  brace pair (e.g. `v0.99.8{caret}\\{commit\\}`) means the object\n+  brace pair (e.g. 'v0.99.8{caret}\\{commit\\}') means the object\n   could be a tag, and dereference the tag recursively until an\n   object of that type is found or the object cannot be\n-  dereferenced anymore (in which case, barf).  `rev{caret}0`\n-  introduced earlier is a short-hand for `rev{caret}\\{commit\\}`.\n+  dereferenced anymore (in which case, barf).  'rev{caret}0'\n+  introduced earlier is a short-hand for 'rev{caret}\\{commit\\}'.\n\n * A suffix '{caret}' followed by an empty brace pair\n-  (e.g. `v0.99.8{caret}\\{\\}`) means the object could be a tag,\n+  (e.g. 'v0.99.8{caret}\\{\\}') means the object could be a tag,\n   and dereference the tag recursively until a non-tag object is\n   found.\n\n@@ -314,25 +314,25 @@ specifying a single revision with the notation\ndescribed in the\n previous section means the set of commits reachable from that\n commit, following the commit ancestry chain.\n\n-To exclude commits reachable from a commit, a prefix `{caret}`\n-notation is used.  E.g. `{caret}r1 r2` means commits reachable\n+To exclude commits reachable from a commit, a prefix '{caret}'\n+notation is used.  E.g. '{caret}r1 r2' means commits reachable\n from `r2` but exclude the ones reachable from `r1`.\n\n This set operation appears so often that there is a shorthand\n for it.  When you have two commits `r1` and `r2` (named according\n to the syntax explained in SPECIFYING REVISIONS above), you can ask\n for commits that are reachable from r2 excluding those that are reachable\n-from r1 by `{caret}r1 r2` and it can be written as `r1..r2`.\n+from r1 by '{caret}r1 r2' and it can be written as 'r1..r2'.\n\n-A similar notation `r1\\...r2` is called symmetric difference\n+A similar notation 'r1\\...r2' is called symmetric difference\n of `r1` and `r2` and is defined as\n `r1 r2 --not $(git merge-base --all r1 r2)`.\n It is the set of commits that are reachable from either one of\n `r1` or `r2` but not from both.\n\n Two other shorthands for naming a set that is formed by a commit\n-and its parent commits exist.  The `r1{caret}@` notation means all\n-parents of `r1`.  `r1{caret}!` includes commit `r1` but excludes\n+and its parent commits exist.  The 'r1{caret}@' notation means all\n+parents of `r1`.  'r1{caret}!' includes commit `r1` but excludes\n all of its parents.\n\n Here are a handful of examples:\ndiff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt\nindex c21d19e..fe3ee38 100644\n--- a/Documentation/git-rm.txt\n+++ b/Documentation/git-rm.txt\n@@ -78,7 +78,7 @@ a file that you have not told git about does not\nremove that file.\n\n File globbing matches across directory boundaries.  Thus, given\n two directories `d` and `d2`, there is a difference between\n-using `git rm \\'d\\*\\'` and `git rm \\'d/\\*\\'`, as the former will\n+using `git rm 'd*'` and `git rm 'd/*'`, as the former will\n also remove all of directory `d2`.\n\n REMOVING FILES THAT HAVE DISAPPEARED FROM THE FILESYSTEM\n@@ -136,10 +136,10 @@ git diff --name-only --diff-filter=D -z | xargs\n-0 git rm --cached\n EXAMPLES\n --------\n git rm Documentation/\\\\*.txt::\n-\tRemoves all `\\*.txt` files from the index that are under the\n+\tRemoves all `*.txt` files from the index that are under the\n \t`Documentation` directory and any of its subdirectories.\n +\n-Note that the asterisk `\\*` is quoted from the shell in this\n+Note that the asterisk `*` is quoted from the shell in this\n example; this lets git, and not the shell, expand the pathnames\n of files and subdirectories under the `Documentation/` directory.\n\n-- \n1.6.5\n"},{"id":"131867","messageId":"201001161120.14846.trast@student.ethz.ch","threadId":"22241","inReplyTo":"f3271551001160002r25cb0ac7hc96891f4af22bd03@mail.gmail.com","subject":"Re: [PATCH] Fix bad quoting in documentation","fromName":"Thomas Rast","fromEmail":"trast@student.ethz.ch","sentAt":"2010-01-16T10:20:11Z","receivedAt":"2010-01-16T10:20:11Z","isPatch":true,"sender":{"key":"tr@thomasrast.ch","avatar":"https://avatars.githubusercontent.com/u/153510?v=4"},"body":"Ramkumar Ramachandra wrote:\n> Reported by Frédéric Brière <fbriere@fbriere.net> through\n> http://bugs.debian.org/540001\n\nDoes this fix anything except the instances already handled by 71c020c\n(Disable asciidoc 8.4.1+ semantics for `{plus}` and friends,\n2009-07-25)?\n\nIf so, please point them out for easier review.\n\nIf not, please tell the debian guys to set ASCIIDOC8=YesPlease when\nbuilding the docs.\n\n-- \nThomas Rast\ntrast@{inf,student}.ethz.ch\n"},{"id":"131872","messageId":"f3271551001160300m24932ad4wfd72abc826f2bb65@mail.gmail.com","threadId":"22241","inReplyTo":"201001161120.14846.trast@student.ethz.ch","subject":"Re: [PATCH] Fix bad quoting in documentation","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2010-01-16T11:00:00Z","receivedAt":"2010-01-16T11:00:00Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"Hi,\n\n> If not, please tell the debian guys to set ASCIIDOC8=YesPlease when\n> building the docs.\n\nThanks! The Makefile clearly points this out. I'll let the Debian people know.\n\n-- Ram\n"},{"id":"131876","messageId":"871vhqi7lo.fsf@mithlond.arda","threadId":"22241","inReplyTo":"f3271551001160300m24932ad4wfd72abc826f2bb65@mail.gmail.com","subject":"Re: [PATCH] Fix bad quoting in documentation","fromName":"Teemu Likonen","fromEmail":"tlikonen@iki.fi","sentAt":"2010-01-16T11:58:59Z","receivedAt":"2010-01-16T11:58:59Z","isPatch":true,"sender":{"key":"tlikonen@iki.fi","avatar":null},"body":"On 2010-01-16 16:30 (+0530), Ramkumar Ramachandra wrote:\n\n>> If not, please tell the debian guys to set ASCIIDOC8=YesPlease when\n>> building the docs.\n>\n> Thanks! The Makefile clearly points this out. I'll let the Debian\n> people know.\n\nGit 1:1.6.6-1 in Debian's unstable repository is built with\nASCIIDOC8=YesPlease and ASCIIDOC_NO_ROFF=Yes options.\n"}]}