public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Jeff King <peff@peff•net>
To: kristofferhaugsbakk@fastmail•com
Cc: Junio C Hamano <gitster@pobox•com>,
	git@vger•kernel.org, Kristoffer Haugsbakk <code@khaugsbakk•name>
Subject: Re: [PATCH] doc: commit: link to git-status(1) on all format options
Date: Tue, 18 Nov 2025 04:09:52 -0500	[thread overview]
Message-ID: <20251118090952.GA17717@coredump.intra.peff.net> (raw)
In-Reply-To: <c4349a03724.1763129061.git.code@khaugsbakk.name>

On Fri, Nov 14, 2025 at 03:04:47PM +0100, kristofferhaugsbakk@fastmail•com wrote:

> From: Kristoffer Haugsbakk <code@khaugsbakk•name>
> 
> `--branch` and `--long` refer to git-status(1) options but they don’t tell us
> what `short-format` and `long-format` are, respectively. And `--null`
> mentions “status” but does not link to the command.
> 
> Refer to git-config(1) on `--branch` like `--short` does.
> 
> `long-format` is the git-status(1) output. So we can just say that
> directly.
> 
> Replace “status” with a `linkgit` on `--null`.

Thanks, these all make sense to me.

>     Cc Peff based on:
>     
>     • f3f47a1e (status: add --long output format option, 2012-10-18) did not
>       • Did not link to git-config(1)
>     link to git-config(1) even though the previous
>     • 7c9f7038 (commit: support alternate status formats, 2009-09-05)
>       • This older commit did
>     
>     I was going to mention these when I was only changing `--long` but the
>     scope expanded to the other two options.

Yeah, I don't think I had a particular reason to link in one commit but
not the other. I can only say given the timestamps that I must have been
young and impetuous.

-Peff

      parent reply	other threads:[~2025-11-18  9:09 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-14 14:04 [PATCH] doc: commit: link to git-status(1) on all format options kristofferhaugsbakk
2025-11-17  1:07 ` Junio C Hamano
2025-11-18  9:09 ` Jeff King [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251118090952.GA17717@coredump.intra.peff.net \
    --to=peff@peff$(echo .)net \
    --cc=code@khaugsbakk$(echo .)name \
    --cc=git@vger$(echo .)kernel.org \
    --cc=gitster@pobox$(echo .)com \
    --cc=kristofferhaugsbakk@fastmail$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox