Re: [PATCH] doc: mention rev-list --ancestry-path restrictions
- From
Kai Koponen <kaikoponen@google.com>
- Date
- Dec 3, 2024, 17:59 UTC
- Message-ID
- <CADYQcGrME0wDrhDu6HQsX2Vo7A3bPPr3Ooio3bBFcBg6XaHuYQ@mail.gmail.com>
- In-Reply-To
- <3bf4e4bc-c807-4bbb-8920-afba077413b4@app.fastmail.com>
Apologies, I made a mistake while copying the patch in manually from format-patch; my git install doesn't have send-email available, I'll fix that.
On Tue, Dec 3, 2024 at 12:39 PM Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com> wrote:
Show 56 quoted lines
>
> Hello Kai
>
> On Tue, Dec 3, 2024, at 18:14, Kai Koponen wrote:
> > The rev-list documentation doesn't mention that the given
> > commit must be in the specified commit range, leading
> > to unexpected results.
> >
> > Signed-off-by: Kai Koponen <kaikopone@google.com>
> > ---
> > Documentation/rev-list-options.txt | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
>
> I couldn’t apply this patch to `master` (cc01bad4a9f (The twelfth batch,
> 2024-11-27)). It looks like it is because..
>
> >
> > diff --git a/Documentation/rev-list-options.txt
> > b/Documentation/rev-list-options.txt
> > index 00ccf68744..f0a46f9da5 100644
> > --- a/Documentation/rev-list-options.txt
> > +++ b/Documentation/rev-list-options.txt
> > @@ -412,7 +412,7 @@ 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
>
> This line got corrupted (linebreak).
>
> I see that you used git-send-email(1). Did you edit the patch file
> manually in order to add the quotation from Junio below? I’m guessing
> the editor then broke that line since it is 102 characters when
> combined/joined. I guess you could use cat(1) instead. I like to use
> Git Notes. You can add a note to the commit and then use that default
> namespace (commits) when making the patch.
>
> git notes edit
> git format-patch --notes=commits ...
>
> Although in this case it might be better to add a linebreak since the
> line gets so long. You can add one short line so that you don’t get the
> reflow-paragraph problem from the previous version:
>
> (these are with space indentation instead of tabs)
>
> --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'), only display commits in that range,
> + and a commit <commit> 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