[Buildroot] [next 1/1] docs/manual/patch-policy.txt: patch subjects shall not be numbered

[Buildroot] [next 1/1] docs/manual/patch-policy.txt: patch subjects shall not be numbered

[Julien Olivain]

The script "utils/check-package" checks that patch email prefix are
not be numbered. See:
https://git.buildroot.org/buildroot/tree/utils/checkpackagelib/lib_patch.py?h=2022.08-rc1#n42

The error message recommends to generate patches to be included in
Buildroot with the command 'git format-patch -N'.

The patch policy section in the Buildroot manual does mention that.

This commit adds a note about that requirement.

Signed-off-by: Julien Olivain <ju.o@free.fr>
---
 docs/manual/patch-policy.txt | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/docs/manual/patch-policy.txt b/docs/manual/patch-policy.txt
index e704a0d3f3..063ef984d8 100644
--- a/docs/manual/patch-policy.txt
+++ b/docs/manual/patch-policy.txt
@@ -44,6 +44,11 @@ These patch files should be named +<number>-<description>.patch+.
 - The field +<number>+ in the patch file name refers to the 'apply order',
   and shall start at 1; It is preferred to pad the number with zeros up to 4
   digits, like 'git-format-patch' does. E.g.: +0001-foobar-the-buz.patch+
+- The patch email subject prefix shall not be numbered. Patches shall
+  be generated with the +git format-patch -N+ command, since this
+  numbering is automatically added for series. For example, the patch
+  subject line should look like +Subject: [PATCH] foobar the buz+ rather
+  than +Subject: [PATCH n/m] foobar the buz+.
 - Previously, it was mandatory for patches to be prefixed with the name of
   the package, like +<package>-<number>-<description>.patch+, but that is
   no longer the case. Existing packages will be fixed as time passes. 'Do
-- 
2.37.2

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [next 1/1] docs/manual/patch-policy.txt: patch subjects shall not be numbered

[Yann E. MORIN]

Julien, All,

On 2022-08-28 11:24 +0200, Julien Olivain spake thusly:
> The script "utils/check-package" checks that patch email prefix are
> not be numbered. See:
> https://git.buildroot.org/buildroot/tree/utils/checkpackagelib/lib_patch.py?h=2022.08-rc1#n42
> 
> The error message recommends to generate patches to be included in
> Buildroot with the command 'git format-patch -N'.
> 
> The patch policy section in the Buildroot manual does mention that.
> 
> This commit adds a note about that requirement.
> 
> Signed-off-by: Julien Olivain <ju.o@free.fr>

I've shortened the subject prefix to "docs/manual:", and even though you
marked it for next, this is still documentation and thus material for
master.

Applied to master, thanks.

Regards,
Yann E. MORIN.

> ---
>  docs/manual/patch-policy.txt | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/docs/manual/patch-policy.txt b/docs/manual/patch-policy.txt
> index e704a0d3f3..063ef984d8 100644
> --- a/docs/manual/patch-policy.txt
> +++ b/docs/manual/patch-policy.txt
> @@ -44,6 +44,11 @@ These patch files should be named +<number>-<description>.patch+.
>  - The field +<number>+ in the patch file name refers to the 'apply order',
>    and shall start at 1; It is preferred to pad the number with zeros up to 4
>    digits, like 'git-format-patch' does. E.g.: +0001-foobar-the-buz.patch+
> +- The patch email subject prefix shall not be numbered. Patches shall
> +  be generated with the +git format-patch -N+ command, since this
> +  numbering is automatically added for series. For example, the patch
> +  subject line should look like +Subject: [PATCH] foobar the buz+ rather
> +  than +Subject: [PATCH n/m] foobar the buz+.
>  - Previously, it was mandatory for patches to be prefixed with the name of
>    the package, like +<package>-<number>-<description>.patch+, but that is
>    no longer the case. Existing packages will be fixed as time passes. 'Do
> -- 
> 2.37.2
> 
> _______________________________________________
> buildroot mailing list
> buildroot@buildroot.org
> https://lists.buildroot.org/mailman/listinfo/buildroot

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [next 1/1] docs/manual/patch-policy.txt: patch subjects shall not be numbered

[Peter Korsgaard]

>>>>> "Julien" == Julien Olivain <ju.o@free.fr> writes:

 > The script "utils/check-package" checks that patch email prefix are
 > not be numbered. See:
 > https://git.buildroot.org/buildroot/tree/utils/checkpackagelib/lib_patch.py?h=2022.08-rc1#n42

 > The error message recommends to generate patches to be included in
 > Buildroot with the command 'git format-patch -N'.

 > The patch policy section in the Buildroot manual does mention that.

 > This commit adds a note about that requirement.

 > Signed-off-by: Julien Olivain <ju.o@free.fr>

Committed to 2022.05.x and 2022.02.x, thanks.

-- 
Bye, Peter Korsgaard
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot