Re: [PATCH v5 11/14] replay: use standard revision ranges

From: Linus Arver <linusa@google.com>
Date: Oct 19, 2023, 19:49 UTC
Message-ID: <owlypm1aqto0.fsf@fine.c.googlers.com>
In-Reply-To: <20231010123847.2777056-12-christian.couder@gmail.com>

This patch's documentation bits LGTM. The comments I have below are all nits and I don't think they are enough to require a re-roll. If v5 is accepted as-is, then this stuff could be #leftoverbits for a future (minor) cleanup.

Thanks!

Christian Couder <christian.couder@gmail.com> writes:

Show 8 quoted lines

> From: Elijah Newren <newren@gmail.com>
> 
> +DESCRIPTION
> +-----------
> +
> +Takes a range of commits and replays them onto a new location. Leaves
> +the working tree and the index untouched, and updates no
> +references.

Nit: in v4 you had

     Does
    +not touch the working tree or index, and does not update any
    +references.

and the "does not update any references" sounds more natural than "updates no references".

Show 5 quoted lines

> The output of this command is meant to be used as input to
> +`git update-ref --stdin`, which would update the relevant branches
> +(see the OUTPUT section below).
> +
> +THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.

Nit: add "IN THE FUTURE" at the end.

> +EXAMPLES
> +--------
> +
> +To simply rebase `mybranch` onto `target`:

Nit: s/To simply rebase/Rebase

or, remove "simply" because it doesn't add much value.