diff mbox series

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

Message ID CADYQcGrD5KtM1sZQbccAtDaLmUXD8Gxv_nUWmapjfZm=TMq=Jw@mail.gmail.com (mailing list archive)
State Superseded
Headers show
Series doc: mention rev-list --ancestry-path restrictions | expand

Commit Message

Kai Koponen Dec. 3, 2024, 5:14 p.m. UTC
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(-)

  excluded part of the range) as <commit>.  Can be passed multiple

Comments

Kristoffer Haugsbakk Dec. 3, 2024, 5:38 p.m. UTC | #1
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
Kai Koponen Dec. 3, 2024, 5:59 p.m. UTC | #2
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:
>
> 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
Kai Koponen Dec. 3, 2024, 8:21 p.m. UTC | #3
Re-trying via GitGitGadget at
https://lore.kernel.org/git/pull.1838.git.git.1733257083739.gitgitgadget@gmail.com/

On Tue, Dec 3, 2024 at 12:59 PM Kai Koponen <kaikoponen@google.com> wrote:
>
> 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:
> >
> > 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
Junio C Hamano Dec. 3, 2024, 11:24 p.m. UTC | #4
Kai Koponen <kaikoponen@google.com> writes:

> 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(-)
>
> 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
>   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

Thanks for accomodating my pickyness ;-)  This version reads very
well.

Will queue.
Junio C Hamano Dec. 3, 2024, 11:33 p.m. UTC | #5
"Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com> writes:

> Hello Kai
>
> I couldn’t apply this patch to `master` (cc01bad4a9f (The twelfth batch,
> 2024-11-27)). It looks like it is because..

yes it is heavily whitespace damaged.  Here is what I applied after
manually reconstructing.

--- >8 ---
From: Kai Koponen <kaikoponen@google.com>
Date: Tue, 3 Dec 2024 12:14:34 -0500
Subject: [PATCH] doc: mention rev-list --ancestry-path restrictions

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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 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 0d90d5b154..9d5243e0aa 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -401,7 +401,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
Kai Koponen Dec. 3, 2024, 11:36 p.m. UTC | #6
Thanks for fixing the mangling, pickiness is definitely called for a
huge project like this with lots of work on the maintainers. Wish
gmail didn't eat tabs in plain text mode... the github app was easier
to use than I expected though.

On Tue, Dec 3, 2024 at 6:33 PM Junio C Hamano <gitster@pobox.com> wrote:
>
> "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com> writes:
>
> > Hello Kai
> >
> > I couldn’t apply this patch to `master` (cc01bad4a9f (The twelfth batch,
> > 2024-11-27)). It looks like it is because..
>
> yes it is heavily whitespace damaged.  Here is what I applied after
> manually reconstructing.
>
> --- >8 ---
> From: Kai Koponen <kaikoponen@google.com>
> Date: Tue, 3 Dec 2024 12:14:34 -0500
> Subject: [PATCH] doc: mention rev-list --ancestry-path restrictions
>
> 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>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  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 0d90d5b154..9d5243e0aa 100644
> --- a/Documentation/rev-list-options.txt
> +++ b/Documentation/rev-list-options.txt
> @@ -401,7 +401,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
> --
> 2.47.1-529-gecd20ec0f1
>
diff mbox series

Patch

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
  that are ancestors of <commit>, descendants of <commit>, or
  <commit> itself.  If no commit is specified, use 'commit1' (the