{"thread":{"id":"50884","subject":"[PATCH 2/2] describe doc: remove '7-char' abbreviation reference","startedAt":"2019-04-06T13:27:56Z","lastAt":"2019-04-08T01:10:17Z","messageCount":7,"participants":["Philip Oakley","Ævar Arnfjörð Bjarmason","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"373324","messageId":"20190406132747.16376-3-philipoakley@iee.org","threadId":"50884","inReplyTo":"20190406132747.16376-1-philipoakley@iee.org","subject":"[PATCH 2/2] describe doc: remove '7-char' abbreviation reference","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2019-04-06T13:27:47Z","receivedAt":"2019-04-06T13:27:56Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"While the minimum is 7-char, the unambiguous length can be longer.\n\nSigned-off-by: Philip Oakley <philipoakley@iee.org>\n---\nnoticed while looking int the Git-for-Windows patch thicket -\nwas looking for the ~n^m style!\n---\n Documentation/git-describe.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt\nindex ccdc5f83d6..a88f6ae2c6 100644\n--- a/Documentation/git-describe.txt\n+++ b/Documentation/git-describe.txt\n@@ -139,7 +139,7 @@ at the end.\n \n The number of additional commits is the number\n of commits which would be displayed by \"git log v1.0.4..parent\".\n-The hash suffix is \"-g\" + 7-char abbreviation for the tip commit\n+The hash suffix is \"-g\" + unambiguous abbreviation for the tip commit\n of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`).\n The \"g\" prefix stands for \"git\" and is used to allow describing the version of\n a software depending on the SCM the software is managed with. This is useful\n-- \n2.21.0.windows.1.80.gdc2ae9a382\n\n"},{"id":"373325","messageId":"20190406132747.16376-1-philipoakley@iee.org","threadId":"50884","inReplyTo":null,"subject":"[PATCH 0/2] Minor document fixes","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2019-04-06T13:27:45Z","receivedAt":"2019-04-06T13:27:58Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"A couple of minor fixes seen while looking at the Git-for-Wondows\npatch thicket and getting my head around the conflict resolutions\n\nI did note that there was potential for the rerere-train to be integrated\nwith the main rerere code, and maybe learn from the range-diff, and the\nrebasing merge todo lists, when repetition is occuring in development.\nMaybe also 'show' options for the resolutions (-cc?). Possibly an\nintersting student project, including its documenation.\n\nPhilip Oakley (2):\n  rerere doc: quote `rerere.enabled`\n  describe doc: remove '7-char' abbreviation reference\n\n Documentation/git-describe.txt | 2 +-\n Documentation/git-rerere.txt   | 2 +-\n 2 files changed, 2 insertions(+), 2 deletions(-)\n\n-- \n2.21.0.windows.1.80.gdc2ae9a382\n\n"},{"id":"373326","messageId":"20190406132747.16376-2-philipoakley@iee.org","threadId":"50884","inReplyTo":"20190406132747.16376-1-philipoakley@iee.org","subject":"[PATCH 1/2] rerere doc: quote `rerere.enabled`","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2019-04-06T13:27:46Z","receivedAt":"2019-04-06T13:27:58Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"Signed-off-by: Philip Oakley <philipoakley@iee.org>\n---\nNoticed while attempting to train the Git-for-Windows rebasing-\nmerge series.\n---\n Documentation/git-rerere.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt\nindex df310d2a58..95763d7581 100644\n--- a/Documentation/git-rerere.txt\n+++ b/Documentation/git-rerere.txt\n@@ -24,7 +24,7 @@ on the initial manual merge, and applying previously recorded\n hand resolutions to their corresponding automerge results.\n \n [NOTE]\n-You need to set the configuration variable rerere.enabled in order to\n+You need to set the configuration variable `rerere.enabled` in order to\n enable this command.\n \n \n-- \n2.21.0.windows.1.80.gdc2ae9a382\n\n"},{"id":"373367","messageId":"87bm1ha8ek.fsf@evledraar.gmail.com","threadId":"50884","inReplyTo":"20190406132747.16376-3-philipoakley@iee.org","subject":"Re: [PATCH 2/2] describe doc: remove '7-char' abbreviation reference","fromName":"Ævar Arnfjörð Bjarmason","fromEmail":"avarab@gmail.com","sentAt":"2019-04-07T20:05:07Z","receivedAt":"2019-04-07T20:05:14Z","isPatch":true,"sender":{"key":"avarab@gmail.com","avatar":"https://avatars.githubusercontent.com/u/45301?v=4"},"body":"\nOn Sat, Apr 06 2019, Philip Oakley wrote:\n\n> While the minimum is 7-char, the unambiguous length can be longer.\n>\n> Signed-off-by: Philip Oakley <philipoakley@iee.org>\n> ---\n> noticed while looking int the Git-for-Windows patch thicket -\n> was looking for the ~n^m style!\n> ---\n>  Documentation/git-describe.txt | 2 +-\n>  1 file changed, 1 insertion(+), 1 deletion(-)\n>\n> diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt\n> index ccdc5f83d6..a88f6ae2c6 100644\n> --- a/Documentation/git-describe.txt\n> +++ b/Documentation/git-describe.txt\n> @@ -139,7 +139,7 @@ at the end.\n>\n>  The number of additional commits is the number\n>  of commits which would be displayed by \"git log v1.0.4..parent\".\n> -The hash suffix is \"-g\" + 7-char abbreviation for the tip commit\n> +The hash suffix is \"-g\" + unambiguous abbreviation for the tip commit\n>  of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`).\n>  The \"g\" prefix stands for \"git\" and is used to allow describing the version of\n>  a software depending on the SCM the software is managed with. This is useful\n\nBoth the old/new version are subtly wrong. Whether the new one is better\nis another matter.\n\nFirst, there's more places we mention the now-incorrect 7 characters, at\nleast these (one of which you're fixing). Found by grepping for ' 7 '\nand '7.*abbr':\n\n    Documentation/git-branch.txt-181---abbrev=<length>::\n    Documentation/git-branch.txt-182-       Alter the sha1's minimum display length in the output listing.\n    Documentation/git-branch.txt:183:       The default value is 7 and can be overridden by the `core.abbrev`\n    Documentation/git-branch.txt-184-       config option.\n    Documentation/git-describe.txt-65---abbrev=<n>::\n    Documentation/git-describe.txt:66:      Instead of using the default 7 hexadecimal digits as the\n    Documentation/git-describe.txt-67-      abbreviated object name, use <n> digits, or as many digits\n    Documentation/git-ls-tree.txt-93-Object size identified by <object> is given in bytes, and right-justified\n    Documentation/git-ls-tree.txt:94:with minimum width of 7 characters.  Object size is given only for blobs\n    Documentation/git-ls-tree.txt-95-(file) entries; for other entries `-` character is used in place of size.\n    Documentation/gittutorial-2.txt-44-\n    Documentation/gittutorial-2.txt:45:What are the 7 digits of hex that Git responded to the commit with?\n    Documentation/gittutorial-2.txt-46-\n    [...]\n    Documentation/gittutorial-2.txt-52-name), and that the contents of a Git object will never change (since\n    Documentation/gittutorial-2.txt:53:that would change the object's name as well). The 7 char hex strings\n    Documentation/gittutorial-2.txt-54-here are simply the abbreviation of such 40 character long strings.\n\nIt was never correct that we'd pick 7 characters, we'd *try* that before\ne6c587c733 (\"abbrev: auto size the default abbreviation\", 2016-09-30)\nbut would pick a longer one if it was unambiguous.\n\nWhereas \"unambiguous abbreviation\" isn't correct either, and arguably\nless correct. At least 7 is what we *still* pick as a fallback in lieu\nof the auto-sizing, but just \"unambiguous abbreviation\" implies that in\na repo with some 10 objects we might show just one character, or that\nwe'd post-e6c587c733 pick say 7 characters in a repository where it *is*\nunambiguous but where we've auto-sized to 12.\n\nI've been meaning to follow-up on\nhttps://public-inbox.org/git/20190204161217.20047-1-avarab@gmail.com/\nwhere I among other things wanted to just have these instances all say\n\"commits will be abbreviated as described in XYZ in linkgit:<something>\"\nand summarize what happens there.\n\nI don't mind if this goes in, I mainly wrote this E-Mail as a brain dump\nsince it jolted my memory on the topic, and so that I could dig it up\nlater & see how I intended to follow-up on those #leftoverbits\n"},{"id":"373370","messageId":"xmqqh8b9cys3.fsf@gitster-ct.c.googlers.com","threadId":"50884","inReplyTo":"87bm1ha8ek.fsf@evledraar.gmail.com","subject":"Re: [PATCH 2/2] describe doc: remove '7-char' abbreviation reference","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-04-07T21:04:44Z","receivedAt":"2019-04-07T21:04:49Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:\n\n> I've been meaning to follow-up on\n> https://public-inbox.org/git/20190204161217.20047-1-avarab@gmail.com/\n> where I among other things wanted to just have these instances all say\n> \"commits will be abbreviated as described in XYZ in linkgit:<something>\"\n> and summarize what happens there.\n\nThanks for a pointer.  I do recall that I found that one very\npromising.  I can see from\nhttps://public-inbox.org/git/xmqq7eefv02i.fsf@gitster-ct.c.googlers.com/\nthat I was mostly OK with the end-user facing documentation part,\nand also from\nhttps://public-inbox.org/git/xmqq36p3uxq2.fsf@gitster-ct.c.googlers.com/\nI was OK with the idea of exposing the computation but found that\nthe exact command option it was done with was suboptimal; neither of\nthese was pointing out any incorrectable flaw).\n\n> I don't mind if this goes in, I mainly wrote this E-Mail as a brain dump\n> since it jolted my memory on the topic, and so that I could dig it up\n> later & see how I intended to follow-up on those #leftoverbits\n"},{"id":"373373","messageId":"44d40686-e72a-43dd-4798-b02f41ce92ae@iee.org","threadId":"50884","inReplyTo":"87bm1ha8ek.fsf@evledraar.gmail.com","subject":"Re: [PATCH 2/2] describe doc: remove '7-char' abbreviation reference","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2019-04-07T22:23:55Z","receivedAt":"2019-04-07T22:24:00Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"Hi Ævar\n\nOn 07/04/2019 21:05, Ævar Arnfjörð Bjarmason wrote:\n> On Sat, Apr 06 2019, Philip Oakley wrote:\n>\n>> While the minimum is 7-char, the unambiguous length can be longer.\n>>\n>> Signed-off-by: Philip Oakley <philipoakley@iee.org>\n>> ---\n>> noticed while looking int the Git-for-Windows patch thicket -\n>> was looking for the ~n^m style!\n>> ---\n>>   Documentation/git-describe.txt | 2 +-\n>>   1 file changed, 1 insertion(+), 1 deletion(-)\n>>\n>> diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt\n>> index ccdc5f83d6..a88f6ae2c6 100644\n>> --- a/Documentation/git-describe.txt\n>> +++ b/Documentation/git-describe.txt\n>> @@ -139,7 +139,7 @@ at the end.\n>>\n>>   The number of additional commits is the number\n>>   of commits which would be displayed by \"git log v1.0.4..parent\".\n>> -The hash suffix is \"-g\" + 7-char abbreviation for the tip commit\n>> +The hash suffix is \"-g\" + unambiguous abbreviation for the tip commit\n>>   of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`).\n>>   The \"g\" prefix stands for \"git\" and is used to allow describing the version of\n>>   a software depending on the SCM the software is managed with. This is useful\n> Both the old/new version are subtly wrong. Whether the new one is better\n> is another matter.\n>\n> First, there's more places we mention the now-incorrect 7 characters, at\n> least these (one of which you're fixing). Found by grepping for ' 7 '\n> and '7.*abbr':\n>\n>      Documentation/git-branch.txt-181---abbrev=<length>::\n>      Documentation/git-branch.txt-182-       Alter the sha1's minimum display length in the output listing.\n>      Documentation/git-branch.txt:183:       The default value is 7 and can be overridden by the `core.abbrev`\n>      Documentation/git-branch.txt-184-       config option.\n>      Documentation/git-describe.txt-65---abbrev=<n>::\n>      Documentation/git-describe.txt:66:      Instead of using the default 7 hexadecimal digits as the\n>      Documentation/git-describe.txt-67-      abbreviated object name, use <n> digits, or as many digits\n>      Documentation/git-ls-tree.txt-93-Object size identified by <object> is given in bytes, and right-justified\n>      Documentation/git-ls-tree.txt:94:with minimum width of 7 characters.  Object size is given only for blobs\n>      Documentation/git-ls-tree.txt-95-(file) entries; for other entries `-` character is used in place of size.\n>      Documentation/gittutorial-2.txt-44-\n>      Documentation/gittutorial-2.txt:45:What are the 7 digits of hex that Git responded to the commit with?\n>      Documentation/gittutorial-2.txt-46-\n>      [...]\n>      Documentation/gittutorial-2.txt-52-name), and that the contents of a Git object will never change (since\n>      Documentation/gittutorial-2.txt:53:that would change the object's name as well). The 7 char hex strings\n>      Documentation/gittutorial-2.txt-54-here are simply the abbreviation of such 40 character long strings.\n>\n> It was never correct that we'd pick 7 characters, we'd *try* that before\n> e6c587c733 (\"abbrev: auto size the default abbreviation\", 2016-09-30)\n> but would pick a longer one if it was unambiguous.\n>\n> Whereas \"unambiguous abbreviation\" isn't correct either, and arguably\n> less correct. At least 7 is what we *still* pick as a fallback in lieu\n> of the auto-sizing, but just \"unambiguous abbreviation\" implies that in\n> a repo with some 10 objects we might show just one character, or that\n> we'd post-e6c587c733 pick say 7 characters in a repository where it *is*\n> unambiguous but where we've auto-sized to 12.\n>\n> I've been meaning to follow-up on\n> https://public-inbox.org/git/20190204161217.20047-1-avarab@gmail.com/\n> where I among other things wanted to just have these instances all say\n> \"commits will be abbreviated as described in XYZ in linkgit:<something>\"\n> and summarize what happens there.\n>\n> I don't mind if this goes in, I mainly wrote this E-Mail as a brain dump\n> since it jolted my memory on the topic, and so that I could dig it up\n> later & see how I intended to follow-up on those #leftoverbits\nI had had a look at most of the other '7 ' references and decided that \nmost of those I saw were about the minimum abbreviation settings, but it \nlooks like I maybe missed a few - like the gittutorials.\n\n  I was aware that I was being slightly economical with the truth, but \nwas just looking for a way of implying 'variable length' and I punted on \nthe long explanation as the particular reference was way down the \ndocument. If anyone has a suggestion for a better phrase I'd be happy \nAnd I could add it to the tutorials as well).\n\nPhilip\n(added Junio, given his follow up email, though we still need a term for \nthis.)\n"},{"id":"373381","messageId":"xmqq8swlcney.fsf@gitster-ct.c.googlers.com","threadId":"50884","inReplyTo":"20190406132747.16376-2-philipoakley@iee.org","subject":"Re: [PATCH 1/2] rerere doc: quote `rerere.enabled`","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-04-08T01:10:13Z","receivedAt":"2019-04-08T01:10:17Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Philip Oakley <philipoakley@iee.org> writes:\n\n> Signed-off-by: Philip Oakley <philipoakley@iee.org>\n> ---\n> Noticed while attempting to train the Git-for-Windows rebasing-\n> merge series.\n> ---\n>  Documentation/git-rerere.txt | 2 +-\n>  1 file changed, 1 insertion(+), 1 deletion(-)\n>\n> diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt\n> index df310d2a58..95763d7581 100644\n> --- a/Documentation/git-rerere.txt\n> +++ b/Documentation/git-rerere.txt\n> @@ -24,7 +24,7 @@ on the initial manual merge, and applying previously recorded\n>  hand resolutions to their corresponding automerge results.\n>  \n>  [NOTE]\n> -You need to set the configuration variable rerere.enabled in order to\n> +You need to set the configuration variable `rerere.enabled` in order to\n>  enable this command.\n\nOK.  That sounds good.\n\nThanks.\n"}]}