Skip to contentSkip to conversation

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

PATCH In review Kai Koponen via GitGitGadget 3 participants 3 messages Dec 3, 2024 – Dec 4, 2024 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: mention rev-list --ancestry-path restrictions

From: Kai Koponen <[email protected]>

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

---

    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(-)
Documentation/rev-list-options.txt +2 -1
index 00ccf687441..459e5a02f52 100644
@@ -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

Signature · 1 line
gitgitgadget
#1 lore raw
Quoted 33 lines · Kai Koponen via GitGitGadget

From: Kai Koponen <[email protected]>

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

---

    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(-)
Documentation/rev-list-options.txt +2 -1
index 00ccf687441..459e5a02f52 100644
@@ -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
Quoted 3 lines

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.