diff mbox series

doc: mention rev-list --ancestry-path restrictions

Message ID pull.1838.git.git.1733257083739.gitgitgadget@gmail.com (mailing list archive)
State Accepted
Commit bc1a980759bc61a426c26d3b47e2d77a708a038b
Headers show
Series doc: mention rev-list --ancestry-path restrictions | expand

Commit Message

Kai Koponen Dec. 3, 2024, 8:18 p.m. UTC
From: Kai Koponen <kaikoponen@google.com>

The rev-list documention doesn't mention that the given
commit must be in the specified commit range, leading
to unexpected results.

Signed-off-by: Kai Koponen <kaikoponen@google.com>
---
    doc: mention rev-list --ancestry-path restrictions

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1838%2Fgkaikoponen%2Fmaster-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1838/gkaikoponen/master-v1
Pull-Request: https://github.com/git/git/pull/1838

 Documentation/rev-list-options.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)


base-commit: cc01bad4a9f566cf4453c7edd6b433851b0835e2

Comments

Elijah Newren Dec. 3, 2024, 10:22 p.m. UTC | #1
On Tue, Dec 3, 2024 at 12:18 PM Kai Koponen via GitGitGadget
<gitgitgadget@gmail.com> wrote:
>
> From: Kai Koponen <kaikoponen@google.com>
>
> The rev-list documention doesn't mention that the given
> commit must be in the specified commit range, leading
> to unexpected results.
>
> Signed-off-by: Kai Koponen <kaikoponen@google.com>
> ---
>     doc: mention rev-list --ancestry-path restrictions
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1838%2Fgkaikoponen%2Fmaster-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1838/gkaikoponen/master-v1
> Pull-Request: https://github.com/git/git/pull/1838
>
>  Documentation/rev-list-options.txt | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
> index 00ccf687441..459e5a02f52 100644
> --- a/Documentation/rev-list-options.txt
> +++ b/Documentation/rev-list-options.txt
> @@ -412,7 +412,8 @@ Default mode::
>
>  --ancestry-path[=<commit>]::
>         When given a range of commits to display (e.g. 'commit1..commit2'
> -       or 'commit2 {caret}commit1'), only display commits in that range
> +       or 'commit2 {caret}commit1'), and a commit <commit> in that range,
> +       only display commits in that range
>         that are ancestors of <commit>, descendants of <commit>, or
>         <commit> itself.  If no commit is specified, use 'commit1' (the
>         excluded part of the range) as <commit>.  Can be passed multiple
>
> base-commit: cc01bad4a9f566cf4453c7edd6b433851b0835e2
> --
> gitgitgadget

Might be worth linking to the thread where this was discussed (in
single-commit gitgitgadget PRs, that'd be done in the PR description),
over here: https://lore.kernel.org/git/CADYQcGpXm=RTEYyxqdSowQ4Vg9jmXuCzOOpd-TgDX8U814BReg@mail.gmail.com/

Anyway, patch looks good to me.
Junio C Hamano Dec. 4, 2024, 12:10 a.m. UTC | #2
"Kai Koponen via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Kai Koponen <kaikoponen@google.com>
>
> The rev-list documention doesn't mention that the given
> commit must be in the specified commit range, leading
> to unexpected results.
>
> Signed-off-by: Kai Koponen <kaikoponen@google.com>
> ---
>     doc: mention rev-list --ancestry-path restrictions

Thanks.
diff mbox series

Patch

diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 00ccf687441..459e5a02f52 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -412,7 +412,8 @@  Default mode::
 
 --ancestry-path[=<commit>]::
 	When given a range of commits to display (e.g. 'commit1..commit2'
-	or 'commit2 {caret}commit1'), only display commits in that range
+	or 'commit2 {caret}commit1'), and a commit <commit> in that range,
+	only display commits in that range
 	that are ancestors of <commit>, descendants of <commit>, or
 	<commit> itself.  If no commit is specified, use 'commit1' (the
 	excluded part of the range) as <commit>.  Can be passed multiple