{"thread":{"id":"37186","subject":"[PATCH] Documentation: fix missing text for rev-parse --verify","startedAt":"2014-07-21T23:00:35Z","lastAt":"2014-07-22T23:41:39Z","messageCount":5,"participants":["brian m. carlson","Jonathan Nieder"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"246487","messageId":"1405983635-77468-1-git-send-email-sandals@crustytoothpaste.net","threadId":"37186","inReplyTo":null,"subject":"[PATCH] Documentation: fix missing text for rev-parse --verify","fromName":"brian m. carlson","fromEmail":"sandals@crustytoothpaste.net","sentAt":"2014-07-21T23:00:35Z","receivedAt":"2014-07-21T23:00:35Z","isPatch":true,"sender":{"key":"sandals@crustytoothpaste.net","avatar":"https://avatars.githubusercontent.com/u/497054?v=4"},"body":"The caret (^) is used as a markup symbol in AsciiDoc.  Due to the\ninability of AsciiDoc to parse a line containing an unmatched caret, it\nomitted the line from the output, resulting in the man page missing the\nend of a sentence.  Escape this caret so that the man page ends up with\nthe complete text.\n\nSigned-off-by: brian m. carlson <sandals@crustytoothpaste.net>\n---\n Documentation/git-rev-parse.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt\nindex 9bd76a5..0b84769 100644\n--- a/Documentation/git-rev-parse.txt\n+++ b/Documentation/git-rev-parse.txt\n@@ -102,7 +102,7 @@ eval \"set -- $(git rev-parse --sq --prefix \"$prefix\" \"$@\")\"\n +\n If you want to make sure that the output actually names an object in\n your object database and/or can be used as a specific type of object\n-you require, you can add \"^{type}\" peeling operator to the parameter.\n+you require, you can add \"\\^{type}\" peeling operator to the parameter.\n For example, `git rev-parse \"$VAR^{commit}\"` will make sure `$VAR`\n names an existing object that is a commit-ish (i.e. a commit, or an\n annotated tag that points at a commit).  To make sure that `$VAR`\n-- \n2.0.1\n"},{"id":"246488","messageId":"20140721231438.GZ12427@google.com","threadId":"37186","inReplyTo":"1405983635-77468-1-git-send-email-sandals@crustytoothpaste.net","subject":"Re: [PATCH] Documentation: fix missing text for rev-parse --verify","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2014-07-21T23:14:38Z","receivedAt":"2014-07-21T23:14:38Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"brian m. carlson wrote:\n\n> The caret (^) is used as a markup symbol in AsciiDoc.  Due to the\n> inability of AsciiDoc to parse a line containing an unmatched caret, it\n> omitted the line from the output, resulting in the man page missing the\n> end of a sentence.\n\nWow.  Usually asciidoc is more forgiving than that.  Are there other\npages affected by this too (e.g., \"the commit HEAD^\" in\nuser-manual.txt)?\n\n[...]\n> --- a/Documentation/git-rev-parse.txt\n> +++ b/Documentation/git-rev-parse.txt\n> @@ -102,7 +102,7 @@ eval \"set -- $(git rev-parse --sq --prefix \"$prefix\" \"$@\")\"\n>  +\n>  If you want to make sure that the output actually names an object in\n>  your object database and/or can be used as a specific type of object\n> -you require, you can add \"^{type}\" peeling operator to the parameter.\n> +you require, you can add \"\\^{type}\" peeling operator to the parameter.\n\nDoes using {caret} for ^ work, too?  Generally in asciidoc using a\nbackslash to escape delimiter characters leads to trouble when the\nnumber of delimiters changes or the text is copy+pasted, since in a\ncontext where the backslash is unneeded it ends up being rendered as a\nliteral backslash.\n\nAlternatively, does \"`^{type}`\" work?\n\nThanks,\nJonathan\n"},{"id":"246490","messageId":"20140721233554.GC5616@vauxhall.crustytoothpaste.net","threadId":"37186","inReplyTo":"20140721231438.GZ12427@google.com","subject":"Re: [PATCH] Documentation: fix missing text for rev-parse --verify","fromName":"brian m. carlson","fromEmail":"sandals@crustytoothpaste.net","sentAt":"2014-07-21T23:35:55Z","receivedAt":"2014-07-21T23:35:55Z","isPatch":true,"sender":{"key":"sandals@crustytoothpaste.net","avatar":"https://avatars.githubusercontent.com/u/497054?v=4"},"body":"On Mon, Jul 21, 2014 at 04:14:38PM -0700, Jonathan Nieder wrote:\n> brian m. carlson wrote:\n> \n> > The caret (^) is used as a markup symbol in AsciiDoc.  Due to the\n> > inability of AsciiDoc to parse a line containing an unmatched caret, it\n> > omitted the line from the output, resulting in the man page missing the\n> > end of a sentence.\n> \n> Wow.  Usually asciidoc is more forgiving than that.  Are there other\n> pages affected by this too (e.g., \"the commit HEAD^\" in\n> user-manual.txt)?\n\nI didn't look at any other pages before submitting this.  I noticed when\nI was looking up git rev-parse --verify on my Debian sid laptop at work.\n\nI just looked, and the place you mentioned in user-manual.txt wasn't\naffected.  It looks like this is the only place in running text that we\ndon't use backticks around the caret-containing text.\n\n> > --- a/Documentation/git-rev-parse.txt\n> > +++ b/Documentation/git-rev-parse.txt\n> > @@ -102,7 +102,7 @@ eval \"set -- $(git rev-parse --sq --prefix \"$prefix\" \"$@\")\"\n> >  +\n> >  If you want to make sure that the output actually names an object in\n> >  your object database and/or can be used as a specific type of object\n> > -you require, you can add \"^{type}\" peeling operator to the parameter.\n> > +you require, you can add \"\\^{type}\" peeling operator to the parameter.\n> \n> Does using {caret} for ^ work, too?  Generally in asciidoc using a\n> backslash to escape delimiter characters leads to trouble when the\n> number of delimiters changes or the text is copy+pasted, since in a\n> context where the backslash is unneeded it ends up being rendered as a\n> literal backslash.\n\n{caret} does not work; it leaves the sentence broken still.  `^{type}`\ndoes work.  Since that seems a bit cleaner, and I think the resultant\nformatting is fine, I'll reroll with that change.\n\n-- \nbrian m. carlson / brian with sandals: Houston, Texas, US\n+1 832 623 2791 | http://www.crustytoothpaste.net/~bmc | My opinion only\nOpenPGP: RSA v4 4096b: 88AC E9B2 9196 305B A994 7552 F1BA 225C 0223 B187\n"},{"id":"246535","messageId":"1406072291-99812-1-git-send-email-sandals@crustytoothpaste.net","threadId":"37186","inReplyTo":"20140721233554.GC5616@vauxhall.crustytoothpaste.net","subject":"[PATCH v2] Documentation: fix missing text for rev-parse --verify","fromName":"brian m. carlson","fromEmail":"sandals@crustytoothpaste.net","sentAt":"2014-07-22T23:38:11Z","receivedAt":"2014-07-22T23:38:11Z","isPatch":true,"sender":{"key":"sandals@crustytoothpaste.net","avatar":"https://avatars.githubusercontent.com/u/497054?v=4"},"body":"The caret (^) is used as a markup symbol in AsciiDoc.  Due to the\ninability of AsciiDoc to parse a line containing an unmatched caret, it\nomitted the line from the output, resulting in the man page missing the\nend of a sentence.  The rest of the documentation uses backticks\nwhenever a caret is encountered in running text, so do the same here.\n\nSigned-off-by: brian m. carlson <sandals@crustytoothpaste.net>\n---\n Documentation/git-rev-parse.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt\nindex 9bd76a5..074030f 100644\n--- a/Documentation/git-rev-parse.txt\n+++ b/Documentation/git-rev-parse.txt\n@@ -102,7 +102,7 @@ eval \"set -- $(git rev-parse --sq --prefix \"$prefix\" \"$@\")\"\n +\n If you want to make sure that the output actually names an object in\n your object database and/or can be used as a specific type of object\n-you require, you can add \"^{type}\" peeling operator to the parameter.\n+you require, you can add \"`^{type}`\" peeling operator to the parameter.\n For example, `git rev-parse \"$VAR^{commit}\"` will make sure `$VAR`\n names an existing object that is a commit-ish (i.e. a commit, or an\n annotated tag that points at a commit).  To make sure that `$VAR`\n-- \n2.0.1\n"},{"id":"246536","messageId":"20140722234139.GB10991@google.com","threadId":"37186","inReplyTo":"1406072291-99812-1-git-send-email-sandals@crustytoothpaste.net","subject":"Re: [PATCH v2] Documentation: fix missing text for rev-parse --verify","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2014-07-22T23:41:39Z","receivedAt":"2014-07-22T23:41:39Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"brian m. carlson wrote:\n\n> Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>\n> ---\n>  Documentation/git-rev-parse.txt | 2 +-\n>  1 file changed, 1 insertion(+), 1 deletion(-)\n\nThanks again for catching and fixing it.\n\nReviewed-by: Jonathan Nieder <jrnieder@gmail.com>\n"}]}