Re: [PATCH] doc: mention rev-list --ancestry-path restrictions

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxx>
> ---
>  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





[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux