Git development
 help / color / mirror / Atom feed
From: Marat Khalili <qm2k21@gmail.com>
To: Tamir Duberstein <tamird@gmail.com>, git@vger.kernel.org
Cc: "Jean-Noël Avila" <jn.avila@free.fr>,
	"Junio C Hamano" <gitster@pobox.com>,
	"Miklos Vajna" <vmiklos@collabora.com>
Subject: Re: [PATCH v5] doc: clarify --follow's single-file limitation
Date: Mon, 28 Sep 2026 18:16:38 +0100	[thread overview]
Message-ID: <a745126c-7e40-47e9-afa4-7ebea0640bf6@gmail.com> (raw)
In-Reply-To: <20260926-document-log-no-follow-v5-1-d04efeca7551@gmail.com>

On 26/09/2026 12:56, Tamir Duberstein wrote:
> Saying that --follow works only for a single file leaves open whether
> other inputs are rejected or ignored. In particular, log.follow enables
> following for a directory argument, although that use is unsupported.
>
> Distinguish errors for an explicit --follow with no paths or multiple
> paths from the configured default, which has no effect in those cases.
> State that results for directory arguments and accepted wildcard
> patterns are unspecified, and document --no-follow to disable the mode.
nit: "document --no-follow disabling the mode"?
>
> Assisted-by: LLM
> Signed-off-by: Tamir Duberstein <tamird@gmail.com>

LGTM FWIW (looking at this part of the code right now considering 
possible improvements). Handing of --follow has a few more other 
limitations that can be documented, but fixing them is probably more 
interesting. Disclaimer: I just joined and did not follow this thread 
from the beginning.

Acked-by: Marat Khalili <qm2k21@gmail.com>

// snip

> ---
>   Documentation/config/log.adoc | 10 +++++++---
>   Documentation/git-log.adoc    | 10 ++++++++--
>   2 files changed, 15 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/config/log.adoc b/Documentation/config/log.adoc
> index f7dfce69b5..4efdd4f61b 100644
> --- a/Documentation/config/log.adoc
> +++ b/Documentation/config/log.adoc
> @@ -51,9 +51,13 @@ This is the same as the `--decorate` option of the `git log`.
>   	details. Defaults to `separate`.
>   
>   `log.follow`::
> -	If `true`, `git log` will act as if the `--follow` option was used when
> -	a single <path> is given.  This has the same limitations as `--follow`,
> -	i.e. it cannot be used to follow multiple files.
> +	If `true`, `git log` enables `--follow` when a single <path> is
> +	given. With no paths, multiple paths, or pathspec magic unsupported
> +	by `--follow`, this setting has no effect.
> ++
> +A single directory argument or an accepted wildcard pattern still
> +enables `--follow`, with unspecified results. Use `--no-follow` to
> +override this setting.
>   
>   `log.graphColors`::
>   	A list of colors, separated by commas, that can be used to draw
> diff --git a/Documentation/git-log.adoc b/Documentation/git-log.adoc
> index fb3ac11283..a40b3d1c05 100644
> --- a/Documentation/git-log.adoc
> +++ b/Documentation/git-log.adoc
> @@ -28,8 +28,14 @@ OPTIONS
>   -------
>   
>   `--follow`::
> -	Continue listing the history of a file beyond renames
> -	(works only for a single file).
> +`--no-follow`::
> +	Continue listing the history of a single file beyond renames.
> +	An explicit `--follow` requires exactly one path argument; Git
> +	reports an error if none or more than one is given.
> ++
> +A directory argument is accepted and enables `--follow`, but results
> +for directories and accepted wildcard patterns are unspecified.
> +Use `--no-follow` for directory history or wildcard matching.
>   
>   `--no-decorate`::
>   `--decorate[=(short|full|auto|no)]`::
>
> ---
> base-commit: 0f8e75abebff0877cae681a3d5ff31ac47f54220
> change-id: 20260507-document-log-no-follow-72c33dc15017

      reply	other threads:[~2026-09-28 17:16 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-07 14:14 [PATCH] doc: git-log: document --no-follow Tamir Duberstein
2026-05-07 18:13 ` [PATCH v2] doc: git-log: clarify --follow options Tamir Duberstein
2026-05-10 21:31   ` Junio C Hamano
2026-05-10 22:30     ` Tamir Duberstein
2026-05-10 23:48       ` Junio C Hamano
2026-05-10 23:51         ` Tamir Duberstein
2026-05-10 22:31   ` [PATCH v3] doc: clarify --follow and log.follow for git log Tamir Duberstein
2026-05-10 23:53     ` Junio C Hamano
2026-05-11  0:07       ` Tamir Duberstein
2026-05-11  0:13         ` Junio C Hamano
2026-05-11  0:32           ` Tamir Duberstein
2026-05-11  0:46             ` Junio C Hamano
2026-05-11  1:28               ` Tamir Duberstein
2026-05-11  2:06                 ` Junio C Hamano
2026-06-25 16:01     ` [PATCH v4] " Tamir Duberstein
2026-06-25 17:23       ` Junio C Hamano
2026-09-26 11:56       ` [PATCH v5] doc: clarify --follow's single-file limitation Tamir Duberstein
2026-09-28 17:16         ` Marat Khalili [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=a745126c-7e40-47e9-afa4-7ebea0640bf6@gmail.com \
    --to=qm2k21@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jn.avila@free.fr \
    --cc=tamird@gmail.com \
    --cc=vmiklos@collabora.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
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