{"thread":{"id":"64479","subject":"[PATCH] doc: commit: link to git-status(1) on all format options","startedAt":"2025-11-14T14:05:46Z","lastAt":"2025-11-18T09:09:54Z","messageCount":3,"participants":["kristofferhaugsbakk@fastmail.com","Junio C Hamano","Jeff King"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"530690","messageId":"c4349a03724.1763129061.git.code@khaugsbakk.name","threadId":"64479","inReplyTo":null,"subject":"[PATCH] doc: commit: link to git-status(1) on all format options","fromName":"","fromEmail":"kristofferhaugsbakk@fastmail.com","sentAt":"2025-11-14T14:04:47Z","receivedAt":"2025-11-14T14:05:46Z","isPatch":true,"sender":{"key":"kristofferhaugsbakk@fastmail.com","avatar":null},"body":"From: Kristoffer Haugsbakk <code@khaugsbakk.name>\n\n`--branch` and `--long` refer to git-status(1) options but they don’t tell us\nwhat `short-format` and `long-format` are, respectively. And `--null`\nmentions “status” but does not link to the command.\n\nRefer to git-config(1) on `--branch` like `--short` does.\n\n`long-format` is the git-status(1) output. So we can just say that\ndirectly.\n\nReplace “status” with a `linkgit` on `--null`.\n\nSigned-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>\n---\n\nNotes (series):\n    § Cc\n    \n    Cc Peff based on:\n    \n    • f3f47a1e (status: add --long output format option, 2012-10-18) did not\n      • Did not link to git-config(1)\n    link to git-config(1) even though the previous\n    • 7c9f7038 (commit: support alternate status formats, 2009-09-05)\n      • This older commit did\n    \n    I was going to mention these when I was only changing `--long` but the\n    scope expanded to the other two options.\n\n Documentation/git-commit.adoc | 10 ++++++----\n 1 file changed, 6 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/git-commit.adoc b/Documentation/git-commit.adoc\nindex ae988a883b5..30121b3c861 100644\n--- a/Documentation/git-commit.adoc\n+++ b/Documentation/git-commit.adoc\n@@ -144,24 +144,26 @@ See linkgit:git-rebase[1] for details.\n `--short`::\n \tWhen doing a dry-run, give the output in the short-format. See\n \tlinkgit:git-status[1] for details. Implies `--dry-run`.\n \n `--branch`::\n-\tShow the branch and tracking info even in short-format.\n+\tShow the branch and tracking info even in short-format. See\n+\tlinkgit:git-status[1] for details.\n \n `--porcelain`::\n \tWhen doing a dry-run, give the output in a porcelain-ready\n \tformat. See linkgit:git-status[1] for details. Implies\n \t`--dry-run`.\n \n `--long`::\n-\tWhen doing a dry-run, give the output in the long-format.\n-\tImplies `--dry-run`.\n+\tWhen doing a dry-run, give the output in the long-format. This\n+\tis the default output of linkgit:git-status[1]. Implies\n+\t`--dry-run`.\n \n `-z`::\n `--null`::\n-\tWhen showing `short` or `porcelain` status output, print the\n+\tWhen showing `short` or `porcelain` linkgit:git-status[1] output, print the\n \tfilename verbatim and terminate the entries with _NUL_, instead of _LF_.\n \tIf no format is given, implies the `--porcelain` output format.\n \tWithout the `-z` option, filenames with \"unusual\" characters are\n \tquoted as explained for the configuration variable `core.quotePath`\n \t(see linkgit:git-config[1]).\n-- \n2.52.0.rc1.43.gdcab96589da\n\n"},{"id":"530783","messageId":"xmqqa50lbh6w.fsf@gitster.g","threadId":"64479","inReplyTo":"c4349a03724.1763129061.git.code@khaugsbakk.name","subject":"Re: [PATCH] doc: commit: link to git-status(1) on all format options","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-11-17T01:07:03Z","receivedAt":"2025-11-17T01:07:05Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"kristofferhaugsbakk@fastmail.com writes:\n\n> From: Kristoffer Haugsbakk <code@khaugsbakk.name>\n>\n> `--branch` and `--long` refer to git-status(1) options but they don’t tell us\n> what `short-format` and `long-format` are, respectively. And `--null`\n> mentions “status” but does not link to the command.\n>\n> Refer to git-config(1) on `--branch` like `--short` does.\n>\n> `long-format` is the git-status(1) output. So we can just say that\n> directly.\n>\n> Replace “status” with a `linkgit` on `--null`.\n>\n> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>\n> ---\n\nThis got no raction so far, but given that \"commit --dry-run\" and\n\"status\" share quite a lot of the internals, referring from one to\nthe other often makes sense.\n\nWill mark for 'next'.\n\nThanks.\n\n>\n> Notes (series):\n>     § Cc\n>     \n>     Cc Peff based on:\n>     \n>     • f3f47a1e (status: add --long output format option, 2012-10-18) did not\n>       • Did not link to git-config(1)\n>     link to git-config(1) even though the previous\n>     • 7c9f7038 (commit: support alternate status formats, 2009-09-05)\n>       • This older commit did\n>     \n>     I was going to mention these when I was only changing `--long` but the\n>     scope expanded to the other two options.\n>\n>  Documentation/git-commit.adoc | 10 ++++++----\n>  1 file changed, 6 insertions(+), 4 deletions(-)\n>\n> diff --git a/Documentation/git-commit.adoc b/Documentation/git-commit.adoc\n> index ae988a883b5..30121b3c861 100644\n> --- a/Documentation/git-commit.adoc\n> +++ b/Documentation/git-commit.adoc\n> @@ -144,24 +144,26 @@ See linkgit:git-rebase[1] for details.\n>  `--short`::\n>  \tWhen doing a dry-run, give the output in the short-format. See\n>  \tlinkgit:git-status[1] for details. Implies `--dry-run`.\n>  \n>  `--branch`::\n> -\tShow the branch and tracking info even in short-format.\n> +\tShow the branch and tracking info even in short-format. See\n> +\tlinkgit:git-status[1] for details.\n>  \n>  `--porcelain`::\n>  \tWhen doing a dry-run, give the output in a porcelain-ready\n>  \tformat. See linkgit:git-status[1] for details. Implies\n>  \t`--dry-run`.\n>  \n>  `--long`::\n> -\tWhen doing a dry-run, give the output in the long-format.\n> -\tImplies `--dry-run`.\n> +\tWhen doing a dry-run, give the output in the long-format. This\n> +\tis the default output of linkgit:git-status[1]. Implies\n> +\t`--dry-run`.\n>  \n>  `-z`::\n>  `--null`::\n> -\tWhen showing `short` or `porcelain` status output, print the\n> +\tWhen showing `short` or `porcelain` linkgit:git-status[1] output, print the\n>  \tfilename verbatim and terminate the entries with _NUL_, instead of _LF_.\n>  \tIf no format is given, implies the `--porcelain` output format.\n>  \tWithout the `-z` option, filenames with \"unusual\" characters are\n>  \tquoted as explained for the configuration variable `core.quotePath`\n>  \t(see linkgit:git-config[1]).\n"},{"id":"530878","messageId":"20251118090952.GA17717@coredump.intra.peff.net","threadId":"64479","inReplyTo":"c4349a03724.1763129061.git.code@khaugsbakk.name","subject":"Re: [PATCH] doc: commit: link to git-status(1) on all format options","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2025-11-18T09:09:52Z","receivedAt":"2025-11-18T09:09:54Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Fri, Nov 14, 2025 at 03:04:47PM +0100, kristofferhaugsbakk@fastmail.com wrote:\n\n> From: Kristoffer Haugsbakk <code@khaugsbakk.name>\n> \n> `--branch` and `--long` refer to git-status(1) options but they don’t tell us\n> what `short-format` and `long-format` are, respectively. And `--null`\n> mentions “status” but does not link to the command.\n> \n> Refer to git-config(1) on `--branch` like `--short` does.\n> \n> `long-format` is the git-status(1) output. So we can just say that\n> directly.\n> \n> Replace “status” with a `linkgit` on `--null`.\n\nThanks, these all make sense to me.\n\n>     Cc Peff based on:\n>     \n>     • f3f47a1e (status: add --long output format option, 2012-10-18) did not\n>       • Did not link to git-config(1)\n>     link to git-config(1) even though the previous\n>     • 7c9f7038 (commit: support alternate status formats, 2009-09-05)\n>       • This older commit did\n>     \n>     I was going to mention these when I was only changing `--long` but the\n>     scope expanded to the other two options.\n\nYeah, I don't think I had a particular reason to link in one commit but\nnot the other. I can only say given the timestamps that I must have been\nyoung and impetuous.\n\n-Peff\n"}]}