Re: [PATCH] docs: submitting-patches: improve the base commit explanation

[Konstantin Ryabitsev <konstantin@linuxfoundation.org>]

On Wed, Nov 15, 2023 at 07:56:32PM +0200, Laurent Pinchart wrote:
> When the base of a series is in Linus' tree, or in the corresponding
> subsystem maintainer's tree, things are easy, but there are many
> situations where the base is a merge of multiple branches (perhaps a
> for-next and a fixes branch for instance), or where prerequisites have
> been applied manually for one reason or another. This can and should of
> course be described in the cover letter, and the submitter should push
> and provide a link to a branch that contains the series on top of the
> appropriate base (or just a link to the base). This won't help the bots
> much though, if they just look at the base tag. Is there a way, or can
> we standardize on a way, to indicate where the base can be found ?

Yes, I suggest we use:

base-repository: <some-canonical-repo-url>

So, a b4-submitted series will have these footers:

change-id: <unique-series-id>
base-commit: <commit-id-or-tag>
base-repository: <canonical-repo-url>

(And then, eventually, there will be series dependency info in the format:

requires: <unique-series-id>:<version>

-K