Linux Documentation
 help / color / mirror / Atom feed
From: Weijie Yuan <wy@wyuan.org>
To: Eric Biggers <ebiggers@kernel.org>
Cc: linux-doc@vger.kernel.org, workflows@vger.kernel.org,
	Jonathan Corbet <corbet@lwn.net>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Randy Dunlap <rdunlap@infradead.org>,
	linux-kernel@vger.kernel.org,
	Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Subject: Re: [PATCH] docs: submitting-patches: Require base tree information
Date: Wed, 21 Oct 2026 11:17:14 +0800	[thread overview]
Message-ID: <atguukYG6qCfLHMv@wyuan.org> (raw)
In-Reply-To: <20261020212235.1143086-1-ebiggers@kernel.org>


Eric Biggers <ebiggers@kernel.org> writes:

> Many patches still don't include base tree information and can't be
> applied.  Such patches can't be properly reviewed or tested, nor can
> they be accepted.  submitting-patches.rst already describes how to
> include base tree information, but it's characterized as optional,
> appears only towards the end of the document, and is missing details.
> 
> Make some tweaks to hopefully increase the number of patches that
> include base tree information:
> 
> - Characterize base tree information as required, not optional.
> 
> - Mention it in the "The canonical patch format" section too.
> 
> - Clarify what commits are acceptable to use as base commits.  Also use
>   origin/master instead of master in the example.
> 
> - Mention how to handle prerequisite patches.
> 
> - Suggest setting the format.useAutoBase=true git configuration option.
> 
> - Mention falling back to free-form text as a last resort.
> 
> - Don't say base-commit can go "below the '---' line", since that
>   implied it could go before the diff, which is an unnecessary
>   alternative that differs from what 'git format-patch' produces.
> 
> - Free up some space for the new information by dropping the mention of
>   needing at least git v2.9.0 (since that's quite old by now) and the
>   example of 'git am' (since that isn't directly relevant to submitting
>   patches, which is the topic of submitting-patches.rst).
> 
> Signed-off-by: Eric Biggers <ebiggers@kernel.org>

LGTM!

Reviewed-by: Weijie Yuan <wy@wyuan.org>

Thanks.


  parent reply	other threads:[~2026-10-21  3:17 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-20 21:22 [PATCH] docs: submitting-patches: Require base tree information Eric Biggers
2026-10-20 22:07 ` Konstantin Ryabitsev
2026-10-21  6:07   ` Randy Dunlap
2026-10-21  6:35     ` Krzysztof Kozlowski
2026-10-21  6:44       ` Eric Biggers
2026-10-21  6:47         ` Krzysztof Kozlowski
2026-10-21  3:17 ` Weijie Yuan [this message]
2026-10-21  6:26 ` Krzysztof Kozlowski
2026-10-21  6:39   ` Eric Biggers
2026-10-21  6:41     ` Krzysztof Kozlowski
2026-10-21  6:49       ` Eric Biggers
2026-10-21 11:55         ` Krzysztof Kozlowski
2026-10-21 15:04           ` Konstantin Ryabitsev
2026-10-21 14:19   ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=atguukYG6qCfLHMv@wyuan.org \
    --to=wy@wyuan.org \
    --cc=corbet@lwn.net \
    --cc=ebiggers@kernel.org \
    --cc=konstantin@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=skhan@linuxfoundation.org \
    --cc=workflows@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox