{"thread":{"id":"55190","subject":"[PATCH 0/3] docs: misc cleanup","startedAt":"2021-02-23T06:40:23Z","lastAt":"2021-03-04T01:09:44Z","messageCount":21,"participants":["Denton Liu","Eric Sunshine","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":3},"messages":[{"id":"417534","messageId":"cover.1614062288.git.liu.denton@gmail.com","threadId":"55190","inReplyTo":null,"subject":"[PATCH 0/3] docs: misc cleanup","fromName":"Denton Liu","fromEmail":"liu.denton@gmail.com","sentAt":"2021-02-23T06:39:05Z","receivedAt":"2021-02-23T06:40:23Z","isPatch":true,"sender":{"key":"liu.denton@gmail.com","avatar":"https://avatars.githubusercontent.com/u/9620836?v=4"},"body":"Just a couple of documentation fixes that I noticed in passing today.\nNothing too controversial.\n\nThis branch is based on 'maint'.\n\nDenton Liu (3):\n  i18n.txt: camel case and monospace \"i18n.commitEncoding\"\n  git-cat-file.txt: monospace args and placeholders\n  git-cat-file.txt: remove references to \"sha1\"\n\n Documentation/git-cat-file.txt | 52 +++++++++++++++++-----------------\n Documentation/i18n.txt         |  2 +-\n 2 files changed, 27 insertions(+), 27 deletions(-)\n\n-- \n2.30.0.478.g8a0d178c01\n\n"},{"id":"417535","messageId":"cc48b125166a241ef5f24138fd161223ab35e361.1614062288.git.liu.denton@gmail.com","threadId":"55190","inReplyTo":"cover.1614062288.git.liu.denton@gmail.com","subject":"[PATCH 1/3] i18n.txt: camel case and monospace \"i18n.commitEncoding\"","fromName":"Denton Liu","fromEmail":"liu.denton@gmail.com","sentAt":"2021-02-23T06:39:06Z","receivedAt":"2021-02-23T06:40:26Z","isPatch":true,"sender":{"key":"liu.denton@gmail.com","avatar":"https://avatars.githubusercontent.com/u/9620836?v=4"},"body":"In 95791be750 (doc: camelCase the i18n config variables to improve\nreadability, 2017-07-17), the other i18n config variables were\ncamel cased. However, this one instance was missed.\n\nCamel case and monospace \"i18n.commitEncoding\" so that it matches the\nsurrounding text.\n\nSigned-off-by: Denton Liu <liu.denton@gmail.com>\n---\n Documentation/i18n.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/i18n.txt b/Documentation/i18n.txt\nindex 7e36e5b55b..6c6baeeeb7 100644\n--- a/Documentation/i18n.txt\n+++ b/Documentation/i18n.txt\n@@ -38,7 +38,7 @@ mind.\n   a warning if the commit log message given to it does not look\n   like a valid UTF-8 string, unless you explicitly say your\n   project uses a legacy encoding.  The way to say this is to\n-  have i18n.commitencoding in `.git/config` file, like this:\n+  have `i18n.commitEncoding` in `.git/config` file, like this:\n +\n ------------\n [i18n]\n-- \n2.30.0.478.g8a0d178c01\n\n"},{"id":"417536","messageId":"1ab7ca7fc0928b40c47b53d97695ae911ba93c39.1614062288.git.liu.denton@gmail.com","threadId":"55190","inReplyTo":"cover.1614062288.git.liu.denton@gmail.com","subject":"[PATCH 2/3] git-cat-file.txt: monospace args and placeholders","fromName":"Denton Liu","fromEmail":"liu.denton@gmail.com","sentAt":"2021-02-23T06:39:07Z","receivedAt":"2021-02-23T06:40:26Z","isPatch":true,"sender":{"key":"liu.denton@gmail.com","avatar":"https://avatars.githubusercontent.com/u/9620836?v=4"},"body":"In modern documentation, args and placeholders are monospaced. Format\nall remaining args and placeholders as monospace.\n\nSigned-off-by: Denton Liu <liu.denton@gmail.com>\n---\n Documentation/git-cat-file.txt | 42 +++++++++++++++++-----------------\n 1 file changed, 21 insertions(+), 21 deletions(-)\n\ndiff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt\nindex 8e192d87db..987d170506 100644\n--- a/Documentation/git-cat-file.txt\n+++ b/Documentation/git-cat-file.txt\n@@ -35,42 +35,42 @@ OPTIONS\n \n -t::\n \tInstead of the content, show the object type identified by\n-\t<object>.\n+\t`<object>`.\n \n -s::\n \tInstead of the content, show the object size identified by\n-\t<object>.\n+\t`<object>`.\n \n -e::\n-\tExit with zero status if <object> exists and is a valid\n-\tobject. If <object> is of an invalid format exit with non-zero and\n+\tExit with zero status if `<object>` exists and is a valid\n+\tobject. If `<object>` is of an invalid format exit with non-zero and\n \temits an error on stderr.\n \n -p::\n-\tPretty-print the contents of <object> based on its type.\n+\tPretty-print the contents of `<object>` based on its type.\n \n <type>::\n-\tTypically this matches the real type of <object> but asking\n+\tTypically this matches the real type of `<object>` but asking\n \tfor a type that can trivially be dereferenced from the given\n-\t<object> is also permitted.  An example is to ask for a\n-\t\"tree\" with <object> being a commit object that contains it,\n-\tor to ask for a \"blob\" with <object> being a tag object that\n+\t`<object>` is also permitted.  An example is to ask for a\n+\t\"tree\" with `<object>` being a commit object that contains it,\n+\tor to ask for a \"blob\" with `<object>` being a tag object that\n \tpoints at it.\n \n --textconv::\n \tShow the content as transformed by a textconv filter. In this case,\n-\t<object> has to be of the form <tree-ish>:<path>, or :<path> in\n+\t`<object>` has to be of the form `<tree-ish>:<path>`, or `:<path>` in\n \torder to apply the filter to the content recorded in the index at\n-\t<path>.\n+\t`<path>`.\n \n --filters::\n \tShow the content as converted by the filters configured in\n-\tthe current working tree for the given <path> (i.e. smudge filters,\n-\tend-of-line conversion, etc). In this case, <object> has to be of\n-\tthe form <tree-ish>:<path>, or :<path>.\n+\tthe current working tree for the given `<path>` (i.e. smudge filters,\n+\tend-of-line conversion, etc). In this case, `<object>` has to be of\n+\tthe form `<tree-ish>:<path>`, or `:<path>`.\n \n --path=<path>::\n-\tFor use with --textconv or --filters, to allow specifying an object\n+\tFor use with `--textconv` or `--filters`, to allow specifying an object\n \tname and a path separately, e.g. when it is difficult to figure out\n \tthe revision from which the blob came.\n \n@@ -115,7 +115,7 @@ OPTIONS\n \trepository.\n \n --allow-unknown-type::\n-\tAllow -s or -t to query broken/corrupt objects of unknown type.\n+\tAllow `-s` or `-t` to query broken/corrupt objects of unknown type.\n \n --follow-symlinks::\n \tWith --batch or --batch-check, follow symlinks inside the\n@@ -175,15 +175,15 @@ respectively print:\n \n OUTPUT\n ------\n-If `-t` is specified, one of the <type>.\n+If `-t` is specified, one of the `<type>`.\n \n-If `-s` is specified, the size of the <object> in bytes.\n+If `-s` is specified, the size of the `<object>` in bytes.\n \n-If `-e` is specified, no output, unless the <object> is malformed.\n+If `-e` is specified, no output, unless the `<object>` is malformed.\n \n-If `-p` is specified, the contents of <object> are pretty-printed.\n+If `-p` is specified, the contents of `<object>` are pretty-printed.\n \n-If <type> is specified, the raw (though uncompressed) contents of the <object>\n+If `<type>` is specified, the raw (though uncompressed) contents of the `<object>`\n will be returned.\n \n BATCH OUTPUT\n-- \n2.30.0.478.g8a0d178c01\n\n"},{"id":"417537","messageId":"a24cbbe955f45072ffa88ca16f84e2443720a38f.1614062288.git.liu.denton@gmail.com","threadId":"55190","inReplyTo":"cover.1614062288.git.liu.denton@gmail.com","subject":"[PATCH 3/3] git-cat-file.txt: remove references to \"sha1\"","fromName":"Denton Liu","fromEmail":"liu.denton@gmail.com","sentAt":"2021-02-23T06:39:08Z","receivedAt":"2021-02-23T06:40:26Z","isPatch":true,"sender":{"key":"liu.denton@gmail.com","avatar":"https://avatars.githubusercontent.com/u/9620836?v=4"},"body":"As part of the hash-transition, git can operate on more than just SHA-1\nrepositories. Replace \"sha1\"-specific documentation with hash-agnostic\nterminology.\n\nSigned-off-by: Denton Liu <liu.denton@gmail.com>\n---\n Documentation/git-cat-file.txt | 10 +++++-----\n 1 file changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt\nindex 987d170506..ff89c7bfab 100644\n--- a/Documentation/git-cat-file.txt\n+++ b/Documentation/git-cat-file.txt\n@@ -200,7 +200,7 @@ object, with placeholders of the form `%(atom)` expanded, followed by a\n newline. The available atoms are:\n \n `objectname`::\n-\tThe 40-hex object name of the object.\n+\tThe full hex representation of the object.\n \n `objecttype`::\n \tThe type of the object (the same as `cat-file -t` reports).\n@@ -215,8 +215,8 @@ newline. The available atoms are:\n \n `deltabase`::\n \tIf the object is stored as a delta on-disk, this expands to the\n-\t40-hex sha1 of the delta base object. Otherwise, expands to the\n-\tnull sha1 (40 zeroes). See `CAVEATS` below.\n+\tfull hex representation of the delta base object. Otherwise, expands to the\n+\tnull OID (all zeroes). See `CAVEATS` below.\n \n `rest`::\n \tIf this atom is used in the output string, input lines are split\n@@ -235,14 +235,14 @@ newline.\n For example, `--batch` without a custom format would produce:\n \n ------------\n-<sha1> SP <type> SP <size> LF\n+<oid> SP <type> SP <size> LF\n <contents> LF\n ------------\n \n Whereas `--batch-check='%(objectname) %(objecttype)'` would produce:\n \n ------------\n-<sha1> SP <type> LF\n+<oid> SP <type> LF\n ------------\n \n If a name is specified on stdin that cannot be resolved to an object in\n-- \n2.30.0.478.g8a0d178c01\n\n"},{"id":"417538","messageId":"CAPig+cSgmNZ0woVyP5i9Oy0Rwh8v_7NPu9_LJzCwTV-1mK1vWg@mail.gmail.com","threadId":"55190","inReplyTo":"1ab7ca7fc0928b40c47b53d97695ae911ba93c39.1614062288.git.liu.denton@gmail.com","subject":"Re: [PATCH 2/3] git-cat-file.txt: monospace args and placeholders","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2021-02-23T06:44:59Z","receivedAt":"2021-02-23T06:45:55Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Tue, Feb 23, 2021 at 1:41 AM Denton Liu <liu.denton@gmail.com> wrote:\n> In modern documentation, args and placeholders are monospaced. Format\n> all remaining args and placeholders as monospace.\n>\n> Signed-off-by: Denton Liu <liu.denton@gmail.com>\n> ---\n> diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt\n> @@ -115,7 +115,7 @@ OPTIONS\n>  --allow-unknown-type::\n> -       Allow -s or -t to query broken/corrupt objects of unknown type.\n> +       Allow `-s` or `-t` to query broken/corrupt objects of unknown type.\n>\n>  --follow-symlinks::\n>         With --batch or --batch-check, follow symlinks inside the\n\nMissed these? `--batch`, `--batch-check`\n"},{"id":"417539","messageId":"CAPig+cSy3M4Lp6ej5ca47GzAAOPz2Q9p6cSZWsLs9STu-KauSA@mail.gmail.com","threadId":"55190","inReplyTo":"a24cbbe955f45072ffa88ca16f84e2443720a38f.1614062288.git.liu.denton@gmail.com","subject":"Re: [PATCH 3/3] git-cat-file.txt: remove references to \"sha1\"","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2021-02-23T06:48:50Z","receivedAt":"2021-02-23T06:49:45Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Tue, Feb 23, 2021 at 1:41 AM Denton Liu <liu.denton@gmail.com> wrote:\n> As part of the hash-transition, git can operate on more than just SHA-1\n> repositories. Replace \"sha1\"-specific documentation with hash-agnostic\n> terminology.\n>\n> Signed-off-by: Denton Liu <liu.denton@gmail.com>\n> ---\n> diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt\n> @@ -200,7 +200,7 @@ object, with placeholders of the form `%(atom)` expanded, followed by a\n>  `objectname`::\n> -       The 40-hex object name of the object.\n> +       The full hex representation of the object.\n\nI find this new terminology confusing and ambiguous. To me, this seems\nto be saying that it is a hex representation of the entire object\nrather than a hex representation of the hash of the object. Perhaps\nsay either \"hex representation of the hash of the object\" or \"hex\nrepresentation of the object ID\"?\n\n> @@ -215,8 +215,8 @@ newline. The available atoms are:\n>  `deltabase`::\n>         If the object is stored as a delta on-disk, this expands to the\n> -       40-hex sha1 of the delta base object. Otherwise, expands to the\n> -       null sha1 (40 zeroes). See `CAVEATS` below.\n> +       full hex representation of the delta base object. Otherwise, expands to the\n> +       null OID (all zeroes). See `CAVEATS` below.\n\nSame issue. \"hex representation of the delta base object\" sounds\nmisleading. Should probably mention \"hash of the\" in there somewhere\nor something.\n"},{"id":"417540","messageId":"7dab69ce23b984266ac388ca62e5a37842499797.1614063441.git.liu.denton@gmail.com","threadId":"55190","inReplyTo":"1ab7ca7fc0928b40c47b53d97695ae911ba93c39.1614062288.git.liu.denton@gmail.com","subject":"[PATCH v1.1 2/3] git-cat-file.txt: monospace args, placeholders and filenames","fromName":"Denton Liu","fromEmail":"liu.denton@gmail.com","sentAt":"2021-02-23T06:59:08Z","receivedAt":"2021-02-23T07:00:15Z","isPatch":true,"sender":{"key":"liu.denton@gmail.com","avatar":"https://avatars.githubusercontent.com/u/9620836?v=4"},"body":"In modern documentation, args, placeholders and filenames are\nmonospaced. Apply monospace formatting to these objects.\n\nSigned-off-by: Denton Liu <liu.denton@gmail.com>\n---\nThanks for catching the omission, Eric. I've gone through the\ndocumentation with a fine-tooth comb and caught many more missing\ninstances.\n\n Documentation/git-cat-file.txt | 56 +++++++++++++++++-----------------\n 1 file changed, 28 insertions(+), 28 deletions(-)\n\ndiff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt\nindex 8e192d87db..a1c37a9e81 100644\n--- a/Documentation/git-cat-file.txt\n+++ b/Documentation/git-cat-file.txt\n@@ -35,42 +35,42 @@ OPTIONS\n \n -t::\n \tInstead of the content, show the object type identified by\n-\t<object>.\n+\t`<object>`.\n \n -s::\n \tInstead of the content, show the object size identified by\n-\t<object>.\n+\t`<object>`.\n \n -e::\n-\tExit with zero status if <object> exists and is a valid\n-\tobject. If <object> is of an invalid format exit with non-zero and\n+\tExit with zero status if `<object>` exists and is a valid\n+\tobject. If `<object>` is of an invalid format exit with non-zero and\n \temits an error on stderr.\n \n -p::\n-\tPretty-print the contents of <object> based on its type.\n+\tPretty-print the contents of `<object>` based on its type.\n \n <type>::\n-\tTypically this matches the real type of <object> but asking\n+\tTypically this matches the real type of `<object>` but asking\n \tfor a type that can trivially be dereferenced from the given\n-\t<object> is also permitted.  An example is to ask for a\n-\t\"tree\" with <object> being a commit object that contains it,\n-\tor to ask for a \"blob\" with <object> being a tag object that\n+\t`<object>` is also permitted.  An example is to ask for a\n+\t\"tree\" with `<object>` being a commit object that contains it,\n+\tor to ask for a \"blob\" with `<object>` being a tag object that\n \tpoints at it.\n \n --textconv::\n \tShow the content as transformed by a textconv filter. In this case,\n-\t<object> has to be of the form <tree-ish>:<path>, or :<path> in\n+\t`<object>` has to be of the form `<tree-ish>:<path>`, or `:<path>` in\n \torder to apply the filter to the content recorded in the index at\n-\t<path>.\n+\t`<path>`.\n \n --filters::\n \tShow the content as converted by the filters configured in\n-\tthe current working tree for the given <path> (i.e. smudge filters,\n-\tend-of-line conversion, etc). In this case, <object> has to be of\n-\tthe form <tree-ish>:<path>, or :<path>.\n+\tthe current working tree for the given `<path>` (i.e. smudge filters,\n+\tend-of-line conversion, etc). In this case, `<object>` has to be of\n+\tthe form `<tree-ish>:<path>`, or `:<path>`.\n \n --path=<path>::\n-\tFor use with --textconv or --filters, to allow specifying an object\n+\tFor use with `--textconv` or `--filters`, to allow specifying an object\n \tname and a path separately, e.g. when it is difficult to figure out\n \tthe revision from which the blob came.\n \n@@ -115,15 +115,15 @@ OPTIONS\n \trepository.\n \n --allow-unknown-type::\n-\tAllow -s or -t to query broken/corrupt objects of unknown type.\n+\tAllow `-s` or `-t` to query broken/corrupt objects of unknown type.\n \n --follow-symlinks::\n-\tWith --batch or --batch-check, follow symlinks inside the\n+\tWith `--batch` or `--batch-check`, follow symlinks inside the\n \trepository when requesting objects with extended SHA-1\n \texpressions of the form tree-ish:path-in-tree.  Instead of\n \tproviding output about the link itself, provide output about\n \tthe linked-to object.  If a symlink points outside the\n-\ttree-ish (e.g. a link to /foo or a root-level link to ../foo),\n+\ttree-ish (e.g. a link to `/foo` or a root-level link to `../foo`),\n \tthe portion of the link which is outside the tree will be\n \tprinted.\n +\n@@ -175,15 +175,15 @@ respectively print:\n \n OUTPUT\n ------\n-If `-t` is specified, one of the <type>.\n+If `-t` is specified, one of the `<type>`.\n \n-If `-s` is specified, the size of the <object> in bytes.\n+If `-s` is specified, the size of the `<object>` in bytes.\n \n-If `-e` is specified, no output, unless the <object> is malformed.\n+If `-e` is specified, no output, unless the `<object>` is malformed.\n \n-If `-p` is specified, the contents of <object> are pretty-printed.\n+If `-p` is specified, the contents of `<object>` are pretty-printed.\n \n-If <type> is specified, the raw (though uncompressed) contents of the <object>\n+If `<type>` is specified, the raw (though uncompressed) contents of the `<object>`\n will be returned.\n \n BATCH OUTPUT\n@@ -258,7 +258,7 @@ If a name is specified that might refer to more than one object (an ambiguous sh\n <object> SP ambiguous LF\n ------------\n \n-If --follow-symlinks is used, and a symlink in the repository points\n+If `--follow-symlinks` is used, and a symlink in the repository points\n outside the repository, then `cat-file` will ignore any custom format\n and print:\n \n@@ -267,11 +267,11 @@ symlink SP <size> LF\n <symlink> LF\n ------------\n \n-The symlink will either be absolute (beginning with a /), or relative\n-to the tree root.  For instance, if dir/link points to ../../foo, then\n-<symlink> will be ../foo.  <size> is the size of the symlink in bytes.\n+The symlink will either be absolute (beginning with a `/`), or relative\n+to the tree root.  For instance, if dir/link points to `../../foo`, then\n+`<symlink>` will be `../foo`.  `<size>` is the size of the symlink in bytes.\n \n-If --follow-symlinks is used, the following error messages will be\n+If `--follow-symlinks` is used, the following error messages will be\n displayed:\n \n ------------\n-- \n2.30.1.823.g0a3b79fd18\n\n"},{"id":"417541","messageId":"4030a678b923ca6a49b4e5bc6f0cdf4cf6ae7037.1614064618.git.liu.denton@gmail.com","threadId":"55190","inReplyTo":"a24cbbe955f45072ffa88ca16f84e2443720a38f.1614062288.git.liu.denton@gmail.com","subject":"[PATCH v2] git-cat-file.txt: remove references to \"sha1\"","fromName":"Denton Liu","fromEmail":"liu.denton@gmail.com","sentAt":"2021-02-23T07:17:33Z","receivedAt":"2021-02-23T07:19:06Z","isPatch":true,"sender":{"key":"liu.denton@gmail.com","avatar":"https://avatars.githubusercontent.com/u/9620836?v=4"},"body":"As part of the hash-transition, git can operate on more than just SHA-1\nrepositories. Replace \"sha1\"-specific documentation with hash-agnostic\nterminology.\n\nSigned-off-by: Denton Liu <liu.denton@gmail.com>\n---\n Documentation/git-cat-file.txt | 11 ++++++-----\n 1 file changed, 6 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt\nindex a1c37a9e81..c404a9aae8 100644\n--- a/Documentation/git-cat-file.txt\n+++ b/Documentation/git-cat-file.txt\n@@ -200,7 +200,7 @@ object, with placeholders of the form `%(atom)` expanded, followed by a\n newline. The available atoms are:\n \n `objectname`::\n-\tThe 40-hex object name of the object.\n+\tThe full hex representation of the object ID of the object.\n \n `objecttype`::\n \tThe type of the object (the same as `cat-file -t` reports).\n@@ -215,8 +215,9 @@ newline. The available atoms are:\n \n `deltabase`::\n \tIf the object is stored as a delta on-disk, this expands to the\n-\t40-hex sha1 of the delta base object. Otherwise, expands to the\n-\tnull sha1 (40 zeroes). See `CAVEATS` below.\n+\tfull hex representation of the object ID of the delta base\n+\tobject. Otherwise, expands to the null OID (all zeroes). See\n+\t`CAVEATS` below.\n \n `rest`::\n \tIf this atom is used in the output string, input lines are split\n@@ -235,14 +236,14 @@ newline.\n For example, `--batch` without a custom format would produce:\n \n ------------\n-<sha1> SP <type> SP <size> LF\n+<oid> SP <type> SP <size> LF\n <contents> LF\n ------------\n \n Whereas `--batch-check='%(objectname) %(objecttype)'` would produce:\n \n ------------\n-<sha1> SP <type> LF\n+<oid> SP <type> LF\n ------------\n \n If a name is specified on stdin that cannot be resolved to an object in\n-- \n2.30.1.823.g0a3b79fd18\n\n"},{"id":"417548","messageId":"xmqqzgzv4433.fsf@gitster.g","threadId":"55190","inReplyTo":"4030a678b923ca6a49b4e5bc6f0cdf4cf6ae7037.1614064618.git.liu.denton@gmail.com","subject":"Re: [PATCH v2] git-cat-file.txt: remove references to \"sha1\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-02-23T07:48:32Z","receivedAt":"2021-02-23T07:49:36Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Denton Liu <liu.denton@gmail.com> writes:\n\n>  `objectname`::\n> -\tThe 40-hex object name of the object.\n> +\tThe full hex representation of the object ID of the object.\n\nWhile I agree that it is a good idea to move away from an explicit\nmention of \"40\", I do not see why we would want to explain \"object\nname\" not as \"object name\" but as \"object ID\".  IOW, s/ID/name/.\n\n> @@ -215,8 +215,9 @@ newline. The available atoms are:\n>  \n>  `deltabase`::\n>  \tIf the object is stored as a delta on-disk, this expands to the\n> -\t40-hex sha1 of the delta base object. Otherwise, expands to the\n> -\tnull sha1 (40 zeroes). See `CAVEATS` below.\n> +\tfull hex representation of the object ID of the delta base\n> +\tobject. Otherwise, expands to the null OID (all zeroes). See\n> +\t`CAVEATS` below.\n\nLikewise.  Documentation/glossary-content.txt says \"object name\" is\nthe canonical term, with \"object identifier\", \"hash\" etc. as its\nsynonyms.\n\n> @@ -235,14 +236,14 @@ newline.\n>  For example, `--batch` without a custom format would produce:\n>  \n>  ------------\n> -<sha1> SP <type> SP <size> LF\n> +<oid> SP <type> SP <size> LF\n>  <contents> LF\n>  ------------\n>  \n>  Whereas `--batch-check='%(objectname) %(objecttype)'` would produce:\n>  \n>  ------------\n> -<sha1> SP <type> LF\n> +<oid> SP <type> LF\n>  ------------\n\nThese look good.\n\nThanks.\n"},{"id":"417582","messageId":"xmqq7dmy389l.fsf@gitster.g","threadId":"55190","inReplyTo":"cc48b125166a241ef5f24138fd161223ab35e361.1614062288.git.liu.denton@gmail.com","subject":"Re: [PATCH 1/3] i18n.txt: camel case and monospace \"i18n.commitEncoding\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-02-23T19:15:50Z","receivedAt":"2021-02-23T19:16:45Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Denton Liu <liu.denton@gmail.com> writes:\n\n> In 95791be750 (doc: camelCase the i18n config variables to improve\n> readability, 2017-07-17), the other i18n config variables were\n> camel cased. However, this one instance was missed.\n>\n> Camel case and monospace \"i18n.commitEncoding\" so that it matches the\n> surrounding text.\n>\n> Signed-off-by: Denton Liu <liu.denton@gmail.com>\n> ---\n>  Documentation/i18n.txt | 2 +-\n>  1 file changed, 1 insertion(+), 1 deletion(-)\n\nLooking good.\n\n> diff --git a/Documentation/i18n.txt b/Documentation/i18n.txt\n> index 7e36e5b55b..6c6baeeeb7 100644\n> --- a/Documentation/i18n.txt\n> +++ b/Documentation/i18n.txt\n> @@ -38,7 +38,7 @@ mind.\n>    a warning if the commit log message given to it does not look\n>    like a valid UTF-8 string, unless you explicitly say your\n>    project uses a legacy encoding.  The way to say this is to\n> -  have i18n.commitencoding in `.git/config` file, like this:\n> +  have `i18n.commitEncoding` in `.git/config` file, like this:\n>  +\n>  ------------\n>  [i18n]\n\nThanks, but whenever you noticed an issue like \"Ah, here we used an\nincorrect spelling i18n.commitencoding\", please make it a habit to\nsee if we did exactly the same mistake elsewhere (you have been\nworking with Git long enough to know how cheap such a check is):\n\n    $ git grep -F -e i18n.commitencoding -- \\\n         Documentation/ ':!Documentation/RelNotes/'\n\nand you would have found three other instances.\n\nThis obviously does not have to be part of this miniseries, but I\nwonder if we should have a list of all the configuration variables\nin one place that we can use to record the canonical spelling of\nthese variables.  As\n\n$ git grep -h -E -i \\\n\t-e '^[a-z][-a-z0-9]*\\.[a-z][-a-z0-9]*::' \\\n\t-e '^[a-z][-a-z0-9]*\\.(\\*|<?[a-z][-a-z0-9]*>?)\\.(\\*|<?[a-z][-a-z0-9]*>?)::' \\\n\tDocumentation/config\n\ngives many hits with camelCased names, it might be a good place to\nstart.\n\nPretending that the above gives a good \"canonical list\" (it does not\nyet, if you look at the hits), I got curious how far we can go.\n\nMassaging the output from the above into config-variables.lst\n\n$ ... above command ... |\n  sed -e 's/::$//' |\n  sort -u >config-variables.lst\n\nand then to extract use of these tokens in the main part of the\ndocumentation like this:\n\n$ git grep -h -o -i -F -f config-variables.lst -- \\\n  Documentation/ ':!Documentation/RelNotes/' |\n  sort -u >config-usage.lst\n\ngives us something we can compare with the \"canonical\" usage list.\n\n$ comm -3 config-usage.lst config-variables.lst\nblame.blankboundary\ncore.excludesfile\ncore.filemode\ncore.gitproxy\ncore.ignorestat\ncore.logallrefupdates\ncore.repositoryformatversion\ncore.trustCtime\nhttp.sslverify\nhttp.sslversion\ni18n.commitencoding\npush.pushoption\nremote.<name>.partialCloneFilter\nremote.pushdefault\nrepack.UseDeltaBaseOffset\nsendemail.aliasesfile\nshowbranch.default\ntransfer.hiderefs\nuploadArchive.allowUnreachable\n\nSome of them may be false hits, some may be showing that the copy in\nDocumentation/config/ are spelled in all lowercase, but the majority\nof the hits above seem to be genuine errors similar to what you fixed\nin your patch.\n\nThanks.\n\n\n"},{"id":"417585","messageId":"xmqqy2fe1t6o.fsf_-_@gitster.g","threadId":"55190","inReplyTo":"cc48b125166a241ef5f24138fd161223ab35e361.1614062288.git.liu.denton@gmail.com","subject":"[PATCH v2] i18n.txt: camel case and monospace \"i18n.commitEncoding\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-02-23T19:26:55Z","receivedAt":"2021-02-23T19:28:15Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"In 95791be750 (doc: camelCase the i18n config variables to improve\nreadability, 2017-07-17), the other i18n config variables were\ncamel cased. However, this one instance was missed.\n\nCamel case and monospace \"i18n.commitEncoding\" so that it matches the\nsurrounding text.\n\nSigned-off-by: Denton Liu <liu.denton@gmail.com>\n[jc: fixed 3 other mistakes that are exactly the same]\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\n---\n\n * So, while I still remember, I amended your commit and queued\n   this.\n\n Documentation/git-am.txt       | 2 +-\n Documentation/git-mailinfo.txt | 4 ++--\n Documentation/i18n.txt         | 2 +-\n 3 files changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/git-am.txt b/Documentation/git-am.txt\nindex 06bc063542..decd8ae122 100644\n--- a/Documentation/git-am.txt\n+++ b/Documentation/git-am.txt\n@@ -79,7 +79,7 @@ OPTIONS\n \tPass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).\n \tThe proposed commit log message taken from the e-mail\n \tis re-coded into UTF-8 encoding (configuration variable\n-\t`i18n.commitencoding` can be used to specify project's\n+\t`i18n.commitEncoding` can be used to specify project's\n \tpreferred encoding if it is not UTF-8).\n +\n This was optional in prior versions of git, but now it is the\ndiff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt\nindex 7a6aed0e30..d343f040f5 100644\n--- a/Documentation/git-mailinfo.txt\n+++ b/Documentation/git-mailinfo.txt\n@@ -53,7 +53,7 @@ character.\n \tThe commit log message, author name and author email are\n \ttaken from the e-mail, and after minimally decoding MIME\n \ttransfer encoding, re-coded in the charset specified by\n-\ti18n.commitencoding (defaulting to UTF-8) by transliterating\n+\t`i18n.commitEncoding` (defaulting to UTF-8) by transliterating\n \tthem.  This used to be optional but now it is the default.\n +\n Note that the patch is always used as-is without charset\n@@ -61,7 +61,7 @@ conversion, even with this flag.\n \n --encoding=<encoding>::\n \tSimilar to -u.  But when re-coding, the charset specified here is\n-\tused instead of the one specified by i18n.commitencoding or UTF-8.\n+\tused instead of the one specified by `i18n.commitEncoding` or UTF-8.\n \n -n::\n \tDisable all charset re-coding of the metadata.\ndiff --git a/Documentation/i18n.txt b/Documentation/i18n.txt\nindex 7e36e5b55b..6c6baeeeb7 100644\n--- a/Documentation/i18n.txt\n+++ b/Documentation/i18n.txt\n@@ -38,7 +38,7 @@ mind.\n   a warning if the commit log message given to it does not look\n   like a valid UTF-8 string, unless you explicitly say your\n   project uses a legacy encoding.  The way to say this is to\n-  have i18n.commitencoding in `.git/config` file, like this:\n+  have `i18n.commitEncoding` in `.git/config` file, like this:\n +\n ------------\n [i18n]\n-- \n2.30.1-808-g8fd60da8ea\n\n"},{"id":"417586","messageId":"CAPig+cSSnx3y1Uh6uLvdiMn_xg2--w2-_4VDLqXYJ+WARhc6Gg@mail.gmail.com","threadId":"55190","inReplyTo":"xmqqy2fe1t6o.fsf_-_@gitster.g","subject":"Re: [PATCH v2] i18n.txt: camel case and monospace \"i18n.commitEncoding\"","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2021-02-23T19:32:16Z","receivedAt":"2021-02-23T19:33:11Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Tue, Feb 23, 2021 at 2:28 PM Junio C Hamano <gitster@pobox.com> wrote:\n> In 95791be750 (doc: camelCase the i18n config variables to improve\n> readability, 2017-07-17), the other i18n config variables were\n> camel cased. However, this one instance was missed.\n>\n> Camel case and monospace \"i18n.commitEncoding\" so that it matches the\n> surrounding text.\n>\n> Signed-off-by: Denton Liu <liu.denton@gmail.com>\n> [jc: fixed 3 other mistakes that are exactly the same]\n> Signed-off-by: Junio C Hamano <gitster@pobox.com>\n> ---\n>  * So, while I still remember, I amended your commit and queued\n>    this.\n\nDenton's authorship seems to have been lost (no From: header). Was\nthat intentional?\n"},{"id":"417590","messageId":"xmqqlfbe1sim.fsf@gitster.g","threadId":"55190","inReplyTo":"CAPig+cSSnx3y1Uh6uLvdiMn_xg2--w2-_4VDLqXYJ+WARhc6Gg@mail.gmail.com","subject":"Re: [PATCH v2] i18n.txt: camel case and monospace \"i18n.commitEncoding\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-02-23T19:41:21Z","receivedAt":"2021-02-23T19:42:11Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Eric Sunshine <sunshine@sunshineco.com> writes:\n\n> On Tue, Feb 23, 2021 at 2:28 PM Junio C Hamano <gitster@pobox.com> wrote:\n>> In 95791be750 (doc: camelCase the i18n config variables to improve\n>> readability, 2017-07-17), the other i18n config variables were\n>> camel cased. However, this one instance was missed.\n>>\n>> Camel case and monospace \"i18n.commitEncoding\" so that it matches the\n>> surrounding text.\n>>\n>> Signed-off-by: Denton Liu <liu.denton@gmail.com>\n>> [jc: fixed 3 other mistakes that are exactly the same]\n>> Signed-off-by: Junio C Hamano <gitster@pobox.com>\n>> ---\n>>  * So, while I still remember, I amended your commit and queued\n>>    this.\n>\n> Denton's authorship seems to have been lost (no From: header). Was\n> that intentional?\n\nI didn't even notice.\n\nI actually expect that Denton will produce a more complete series\nbased on the \"comm -3\" output, so that this patch itself (or its\nauthorship) won't matter ;-)\n\nAnd I also expect that somebody will take the \"two greps and comm\"\ntrick I showed and wrap it into some form of doc-lint.  Hint, hint...\n\nThanks.\n\n"},{"id":"417755","messageId":"20210224202641.913770-1-gitster@pobox.com","threadId":"55190","inReplyTo":"xmqqlfbe1sim.fsf@gitster.g","subject":"[PATCH v3 0/3] doc: spell configuration variable names in camelCase","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-02-24T20:26:38Z","receivedAt":"2021-02-24T20:27:33Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"I said in the first review on Denton's patch\n\n    This obviously does not have to be part of this miniseries, but I\n    wonder if we should have a list of all the configuration variables\n    in one place that we can use to record the canonical spelling of\n    these variables.  As\n\n    $ git grep -h -E -i \\\n\t    -e '^[a-z][-a-z0-9]*\\.[a-z][-a-z0-9]*::' \\\n\t    -e '^[a-z][-a-z0-9]*\\.(\\*|<?[a-z][-a-z0-9]*>?)\\.(\\*|<?[a-z][-a-z0-9]*>?)::' \\\n\t    Documentation/config\n\n    gives many hits with camelCased names, it might be a good place to\n    start.\n\n    Pretending that the above gives a good \"canonical list\" (it does not\n    yet, if you look at the hits), I got curious how far we can go.\n\n    Massaging the output from the above into config-variables.lst\n\n    $ ... above command ... |\n      sed -e 's/::$//' |\n      sort -u >config-variables.lst\n\n    and then to extract use of these tokens in the main part of the\n    documentation like this:\n\n    $ git grep -h -o -i -F -f config-variables.lst -- \\\n      Documentation/ ':!Documentation/RelNotes/' |\n      sort -u >config-usage.lst\n\n    gives us something we can compare with the \"canonical\" usage list.\n\n    $ comm -3 config-usage.lst config-variables.lst\n    blame.blankboundary\n    core.excludesfile\n    core.filemode\n    core.gitproxy\n    core.ignorestat\n    core.logallrefupdates\n    core.repositoryformatversion\n    core.trustCtime\n    http.sslverify\n    http.sslversion\n    i18n.commitencoding\n    push.pushoption\n    remote.<name>.partialCloneFilter\n    remote.pushdefault\n    repack.UseDeltaBaseOffset\n    sendemail.aliasesfile\n    showbranch.default\n    transfer.hiderefs\n    uploadArchive.allowUnreachable\n\n    Some of them may be false hits, some may be showing that the copy in\n    Documentation/config/ are spelled in all lowercase, but the majority\n    of the hits above seem to be genuine errors similar to what you fixed\n    in your patch.\n\n    Thanks.\n\nand as I identified a handful of low hanging fruits that way, here\nare a few patches on top of his patch that started the whole thing.\n\nI think we should make sure Documentation/config/*.txt \n\n - spells all the configuration variables in the way we want to see\n   them, and\n\n - covers all the configuration variables.\n\nbefore we can proceed with more low hanging fruits with confidence,\nas I do think the coverage is very good, but I know it is not 100%,\nand the eventual goal should be to make sure we can teach lint-docs\nto catch these before the reviewers even see them.\n\n\nDenton Liu (1):\n  i18n.txt: camel case and monospace \"i18n.commitEncoding\"\n\nJunio C Hamano (2):\n  blame-options.txt: camelcase blame.blankBoundary\n  index-format doc: camelCase core.excludesFile\n\n Documentation/blame-options.txt          | 2 +-\n Documentation/git-am.txt                 | 2 +-\n Documentation/git-mailinfo.txt           | 4 ++--\n Documentation/i18n.txt                   | 2 +-\n Documentation/technical/index-format.txt | 4 ++--\n 5 files changed, 7 insertions(+), 7 deletions(-)\n\n-- \n2.30.1-826-g07a034c5ea\n\n"},{"id":"417756","messageId":"20210224202641.913770-2-gitster@pobox.com","threadId":"55190","inReplyTo":"20210224202641.913770-1-gitster@pobox.com","subject":"[PATCH v3 1/3] i18n.txt: camel case and monospace \"i18n.commitEncoding\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-02-24T20:26:39Z","receivedAt":"2021-02-24T20:27:35Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"From: Denton Liu <liu.denton@gmail.com>\n\nIn 95791be750 (doc: camelCase the i18n config variables to improve\nreadability, 2017-07-17), the other i18n config variables were\ncamel cased. However, this one instance was missed.\n\nCamel case and monospace \"i18n.commitEncoding\" so that it matches the\nsurrounding text.\n\nSigned-off-by: Denton Liu <liu.denton@gmail.com>\n[jc: fixed 3 other mistakes that are exactly the same]\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\n---\n Documentation/git-am.txt       | 2 +-\n Documentation/git-mailinfo.txt | 4 ++--\n Documentation/i18n.txt         | 2 +-\n 3 files changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/git-am.txt b/Documentation/git-am.txt\nindex 06bc063542..decd8ae122 100644\n--- a/Documentation/git-am.txt\n+++ b/Documentation/git-am.txt\n@@ -79,7 +79,7 @@ OPTIONS\n \tPass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).\n \tThe proposed commit log message taken from the e-mail\n \tis re-coded into UTF-8 encoding (configuration variable\n-\t`i18n.commitencoding` can be used to specify project's\n+\t`i18n.commitEncoding` can be used to specify project's\n \tpreferred encoding if it is not UTF-8).\n +\n This was optional in prior versions of git, but now it is the\ndiff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt\nindex 7a6aed0e30..d343f040f5 100644\n--- a/Documentation/git-mailinfo.txt\n+++ b/Documentation/git-mailinfo.txt\n@@ -53,7 +53,7 @@ character.\n \tThe commit log message, author name and author email are\n \ttaken from the e-mail, and after minimally decoding MIME\n \ttransfer encoding, re-coded in the charset specified by\n-\ti18n.commitencoding (defaulting to UTF-8) by transliterating\n+\t`i18n.commitEncoding` (defaulting to UTF-8) by transliterating\n \tthem.  This used to be optional but now it is the default.\n +\n Note that the patch is always used as-is without charset\n@@ -61,7 +61,7 @@ conversion, even with this flag.\n \n --encoding=<encoding>::\n \tSimilar to -u.  But when re-coding, the charset specified here is\n-\tused instead of the one specified by i18n.commitencoding or UTF-8.\n+\tused instead of the one specified by `i18n.commitEncoding` or UTF-8.\n \n -n::\n \tDisable all charset re-coding of the metadata.\ndiff --git a/Documentation/i18n.txt b/Documentation/i18n.txt\nindex 7e36e5b55b..6c6baeeeb7 100644\n--- a/Documentation/i18n.txt\n+++ b/Documentation/i18n.txt\n@@ -38,7 +38,7 @@ mind.\n   a warning if the commit log message given to it does not look\n   like a valid UTF-8 string, unless you explicitly say your\n   project uses a legacy encoding.  The way to say this is to\n-  have i18n.commitencoding in `.git/config` file, like this:\n+  have `i18n.commitEncoding` in `.git/config` file, like this:\n +\n ------------\n [i18n]\n-- \n2.30.1-826-g07a034c5ea\n\n"},{"id":"417757","messageId":"20210224202641.913770-3-gitster@pobox.com","threadId":"55190","inReplyTo":"20210224202641.913770-1-gitster@pobox.com","subject":"[PATCH v3 2/3] blame-options.txt: camelcase blame.blankBoundary","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-02-24T20:26:40Z","receivedAt":"2021-02-24T20:27:44Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"All other references to blame.* configuration variables are\ncamelCased already.  Update this one to match.\n\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\n---\n Documentation/blame-options.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt\nindex dc3bceb6d1..117f4cf806 100644\n--- a/Documentation/blame-options.txt\n+++ b/Documentation/blame-options.txt\n@@ -1,6 +1,6 @@\n -b::\n \tShow blank SHA-1 for boundary commits.  This can also\n-\tbe controlled via the `blame.blankboundary` config option.\n+\tbe controlled via the `blame.blankBoundary` config option.\n \n --root::\n \tDo not treat root commits as boundaries.  This can also be\n-- \n2.30.1-826-g07a034c5ea\n\n"},{"id":"417758","messageId":"20210224202641.913770-4-gitster@pobox.com","threadId":"55190","inReplyTo":"20210224202641.913770-1-gitster@pobox.com","subject":"[PATCH v3 3/3] index-format doc: camelCase core.excludesFile","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-02-24T20:26:41Z","receivedAt":"2021-02-24T20:27:48Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Signed-off-by: Junio C Hamano <gitster@pobox.com>\n---\n Documentation/technical/index-format.txt | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/technical/index-format.txt b/Documentation/technical/index-format.txt\nindex 69edf46c03..8af608055f 100644\n--- a/Documentation/technical/index-format.txt\n+++ b/Documentation/technical/index-format.txt\n@@ -251,14 +251,14 @@ Git index format\n   - Stat data of $GIT_DIR/info/exclude. See \"Index entry\" section from\n     ctime field until \"file size\".\n \n-  - Stat data of core.excludesfile\n+  - Stat data of core.excludesFile\n \n   - 32-bit dir_flags (see struct dir_struct)\n \n   - Hash of $GIT_DIR/info/exclude. A null hash means the file\n     does not exist.\n \n-  - Hash of core.excludesfile. A null hash means the file does\n+  - Hash of core.excludesFile. A null hash means the file does\n     not exist.\n \n   - NUL-terminated string of per-dir exclude file name. This usually\n-- \n2.30.1-826-g07a034c5ea\n\n"},{"id":"418135","messageId":"1b57fdad9767a3b63c359e1663e5a045b4964320.1614763281.git.liu.denton@gmail.com","threadId":"55190","inReplyTo":"cover.1614763281.git.liu.denton@gmail.com","subject":"[PATCH v2 2/2] git-cat-file.txt: remove references to \"sha1\"","fromName":"Denton Liu","fromEmail":"liu.denton@gmail.com","sentAt":"2021-03-03T09:21:56Z","receivedAt":"2021-03-04T00:22:41Z","isPatch":true,"sender":{"key":"liu.denton@gmail.com","avatar":"https://avatars.githubusercontent.com/u/9620836?v=4"},"body":"As part of the hash-transition, git can operate on more than just SHA-1\nrepositories. Replace \"sha1\"-specific documentation with hash-agnostic\nterminology.\n\nSigned-off-by: Denton Liu <liu.denton@gmail.com>\n---\n Documentation/git-cat-file.txt | 11 ++++++-----\n 1 file changed, 6 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt\nindex a1c37a9e81..4eb0421b3f 100644\n--- a/Documentation/git-cat-file.txt\n+++ b/Documentation/git-cat-file.txt\n@@ -200,7 +200,7 @@ object, with placeholders of the form `%(atom)` expanded, followed by a\n newline. The available atoms are:\n \n `objectname`::\n-\tThe 40-hex object name of the object.\n+\tThe full hex representation of the object name.\n \n `objecttype`::\n \tThe type of the object (the same as `cat-file -t` reports).\n@@ -215,8 +215,9 @@ newline. The available atoms are:\n \n `deltabase`::\n \tIf the object is stored as a delta on-disk, this expands to the\n-\t40-hex sha1 of the delta base object. Otherwise, expands to the\n-\tnull sha1 (40 zeroes). See `CAVEATS` below.\n+\tfull hex representation of the delta base object name.\n+\tOtherwise, expands to the null OID (all zeroes). See `CAVEATS`\n+\tbelow.\n \n `rest`::\n \tIf this atom is used in the output string, input lines are split\n@@ -235,14 +236,14 @@ newline.\n For example, `--batch` without a custom format would produce:\n \n ------------\n-<sha1> SP <type> SP <size> LF\n+<oid> SP <type> SP <size> LF\n <contents> LF\n ------------\n \n Whereas `--batch-check='%(objectname) %(objecttype)'` would produce:\n \n ------------\n-<sha1> SP <type> LF\n+<oid> SP <type> LF\n ------------\n \n If a name is specified on stdin that cannot be resolved to an object in\n-- \n2.30.1.823.g0a3b79fd18\n\n"},{"id":"418139","messageId":"cover.1614763281.git.liu.denton@gmail.com","threadId":"55190","inReplyTo":"cover.1614062288.git.liu.denton@gmail.com","subject":"[PATCH v2 0/2] git-cat-file.txt: doc cleanup","fromName":"Denton Liu","fromEmail":"liu.denton@gmail.com","sentAt":"2021-03-03T09:21:54Z","receivedAt":"2021-03-04T00:22:47Z","isPatch":true,"sender":{"key":"liu.denton@gmail.com","avatar":"https://avatars.githubusercontent.com/u/9620836?v=4"},"body":"A couple of fixes that I've noticed in passing.\n\nChanges since v1:\n\n* Drop 'i18n.txt: camel case and monospace \"i18n.commitEncoding\"' (it's already\n  merged to 'master')\n\n* Change \"object ID of the object\" to \"object name\"\n\nDenton Liu (2):\n  git-cat-file.txt: monospace args, placeholders and filenames\n  git-cat-file.txt: remove references to \"sha1\"\n\n Documentation/git-cat-file.txt | 67 +++++++++++++++++-----------------\n 1 file changed, 34 insertions(+), 33 deletions(-)\n\nRange-diff against v1:\n1:  cc48b12516 < -:  ---------- i18n.txt: camel case and monospace \"i18n.commitEncoding\"\n2:  7dab69ce23 = 1:  6d044cf540 git-cat-file.txt: monospace args, placeholders and filenames\n3:  4030a678b9 ! 2:  1b57fdad97 git-cat-file.txt: remove references to \"sha1\"\n    @@ Documentation/git-cat-file.txt: object, with placeholders of the form `%(atom)`\n      \n      `objectname`::\n     -\tThe 40-hex object name of the object.\n    -+\tThe full hex representation of the object ID of the object.\n    ++\tThe full hex representation of the object name.\n      \n      `objecttype`::\n      \tThe type of the object (the same as `cat-file -t` reports).\n    @@ Documentation/git-cat-file.txt: newline. The available atoms are:\n      \tIf the object is stored as a delta on-disk, this expands to the\n     -\t40-hex sha1 of the delta base object. Otherwise, expands to the\n     -\tnull sha1 (40 zeroes). See `CAVEATS` below.\n    -+\tfull hex representation of the object ID of the delta base\n    -+\tobject. Otherwise, expands to the null OID (all zeroes). See\n    -+\t`CAVEATS` below.\n    ++\tfull hex representation of the delta base object name.\n    ++\tOtherwise, expands to the null OID (all zeroes). See `CAVEATS`\n    ++\tbelow.\n      \n      `rest`::\n      \tIf this atom is used in the output string, input lines are split\n-- \n2.30.1.823.g0a3b79fd18\n\n"},{"id":"418143","messageId":"6d044cf540e81ff5218e730172ab5044f7b3a139.1614763281.git.liu.denton@gmail.com","threadId":"55190","inReplyTo":"cover.1614763281.git.liu.denton@gmail.com","subject":"[PATCH v2 1/2] git-cat-file.txt: monospace args, placeholders and filenames","fromName":"Denton Liu","fromEmail":"liu.denton@gmail.com","sentAt":"2021-03-03T09:21:55Z","receivedAt":"2021-03-04T00:22:56Z","isPatch":true,"sender":{"key":"liu.denton@gmail.com","avatar":"https://avatars.githubusercontent.com/u/9620836?v=4"},"body":"In modern documentation, args, placeholders and filenames are\nmonospaced. Apply monospace formatting to these objects.\n\nSigned-off-by: Denton Liu <liu.denton@gmail.com>\n---\n Documentation/git-cat-file.txt | 56 +++++++++++++++++-----------------\n 1 file changed, 28 insertions(+), 28 deletions(-)\n\ndiff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt\nindex 8e192d87db..a1c37a9e81 100644\n--- a/Documentation/git-cat-file.txt\n+++ b/Documentation/git-cat-file.txt\n@@ -35,42 +35,42 @@ OPTIONS\n \n -t::\n \tInstead of the content, show the object type identified by\n-\t<object>.\n+\t`<object>`.\n \n -s::\n \tInstead of the content, show the object size identified by\n-\t<object>.\n+\t`<object>`.\n \n -e::\n-\tExit with zero status if <object> exists and is a valid\n-\tobject. If <object> is of an invalid format exit with non-zero and\n+\tExit with zero status if `<object>` exists and is a valid\n+\tobject. If `<object>` is of an invalid format exit with non-zero and\n \temits an error on stderr.\n \n -p::\n-\tPretty-print the contents of <object> based on its type.\n+\tPretty-print the contents of `<object>` based on its type.\n \n <type>::\n-\tTypically this matches the real type of <object> but asking\n+\tTypically this matches the real type of `<object>` but asking\n \tfor a type that can trivially be dereferenced from the given\n-\t<object> is also permitted.  An example is to ask for a\n-\t\"tree\" with <object> being a commit object that contains it,\n-\tor to ask for a \"blob\" with <object> being a tag object that\n+\t`<object>` is also permitted.  An example is to ask for a\n+\t\"tree\" with `<object>` being a commit object that contains it,\n+\tor to ask for a \"blob\" with `<object>` being a tag object that\n \tpoints at it.\n \n --textconv::\n \tShow the content as transformed by a textconv filter. In this case,\n-\t<object> has to be of the form <tree-ish>:<path>, or :<path> in\n+\t`<object>` has to be of the form `<tree-ish>:<path>`, or `:<path>` in\n \torder to apply the filter to the content recorded in the index at\n-\t<path>.\n+\t`<path>`.\n \n --filters::\n \tShow the content as converted by the filters configured in\n-\tthe current working tree for the given <path> (i.e. smudge filters,\n-\tend-of-line conversion, etc). In this case, <object> has to be of\n-\tthe form <tree-ish>:<path>, or :<path>.\n+\tthe current working tree for the given `<path>` (i.e. smudge filters,\n+\tend-of-line conversion, etc). In this case, `<object>` has to be of\n+\tthe form `<tree-ish>:<path>`, or `:<path>`.\n \n --path=<path>::\n-\tFor use with --textconv or --filters, to allow specifying an object\n+\tFor use with `--textconv` or `--filters`, to allow specifying an object\n \tname and a path separately, e.g. when it is difficult to figure out\n \tthe revision from which the blob came.\n \n@@ -115,15 +115,15 @@ OPTIONS\n \trepository.\n \n --allow-unknown-type::\n-\tAllow -s or -t to query broken/corrupt objects of unknown type.\n+\tAllow `-s` or `-t` to query broken/corrupt objects of unknown type.\n \n --follow-symlinks::\n-\tWith --batch or --batch-check, follow symlinks inside the\n+\tWith `--batch` or `--batch-check`, follow symlinks inside the\n \trepository when requesting objects with extended SHA-1\n \texpressions of the form tree-ish:path-in-tree.  Instead of\n \tproviding output about the link itself, provide output about\n \tthe linked-to object.  If a symlink points outside the\n-\ttree-ish (e.g. a link to /foo or a root-level link to ../foo),\n+\ttree-ish (e.g. a link to `/foo` or a root-level link to `../foo`),\n \tthe portion of the link which is outside the tree will be\n \tprinted.\n +\n@@ -175,15 +175,15 @@ respectively print:\n \n OUTPUT\n ------\n-If `-t` is specified, one of the <type>.\n+If `-t` is specified, one of the `<type>`.\n \n-If `-s` is specified, the size of the <object> in bytes.\n+If `-s` is specified, the size of the `<object>` in bytes.\n \n-If `-e` is specified, no output, unless the <object> is malformed.\n+If `-e` is specified, no output, unless the `<object>` is malformed.\n \n-If `-p` is specified, the contents of <object> are pretty-printed.\n+If `-p` is specified, the contents of `<object>` are pretty-printed.\n \n-If <type> is specified, the raw (though uncompressed) contents of the <object>\n+If `<type>` is specified, the raw (though uncompressed) contents of the `<object>`\n will be returned.\n \n BATCH OUTPUT\n@@ -258,7 +258,7 @@ If a name is specified that might refer to more than one object (an ambiguous sh\n <object> SP ambiguous LF\n ------------\n \n-If --follow-symlinks is used, and a symlink in the repository points\n+If `--follow-symlinks` is used, and a symlink in the repository points\n outside the repository, then `cat-file` will ignore any custom format\n and print:\n \n@@ -267,11 +267,11 @@ symlink SP <size> LF\n <symlink> LF\n ------------\n \n-The symlink will either be absolute (beginning with a /), or relative\n-to the tree root.  For instance, if dir/link points to ../../foo, then\n-<symlink> will be ../foo.  <size> is the size of the symlink in bytes.\n+The symlink will either be absolute (beginning with a `/`), or relative\n+to the tree root.  For instance, if dir/link points to `../../foo`, then\n+`<symlink>` will be `../foo`.  `<size>` is the size of the symlink in bytes.\n \n-If --follow-symlinks is used, the following error messages will be\n+If `--follow-symlinks` is used, the following error messages will be\n displayed:\n \n ------------\n-- \n2.30.1.823.g0a3b79fd18\n\n"},{"id":"418196","messageId":"xmqqzgzjg345.fsf@gitster.c.googlers.com","threadId":"55190","inReplyTo":"cover.1614763281.git.liu.denton@gmail.com","subject":"Re: [PATCH v2 0/2] git-cat-file.txt: doc cleanup","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-03-04T00:43:38Z","receivedAt":"2021-03-04T01:09:44Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Denton Liu <liu.denton@gmail.com> writes:\n\n> Denton Liu (2):\n>   git-cat-file.txt: monospace args, placeholders and filenames\n>   git-cat-file.txt: remove references to \"sha1\"\n\nThanks, will queue.\n"}]}