docs/manual: document the new patch naming convention
PATCH v2 1/1 docs/manual: document the new patch naming convention
To ease generating patches, we now use a naming convention that is in line with what git-format-patch does, that is:
- do not prefix patches with the package name
- prefix patches with a 4-digit mber
- start numbering at 0001
Signed-off-by "Yann E. MORIN" <[email protected]>
Cc Peter Korsgaard <[email protected]>
Cc Thomas Petazzoni <[email protected]>
Cc Thomas De Schampheleire <[email protected]>
Cc Arnout Vandecappelle <[email protected]>
Cc Samuel Martin <[email protected]>
---
Changes v1 -> v2:
- reword slightly (Thomas DS)
--- docs/manual/patch-policy.txt | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-)
docs/manual/patch-policy.txt +14 -7
@@ -31,16 +31,23 @@ Most patches are provided within Buildroot, in the package directory; these typically aim to fix cross-compilation, libc support, or other such issues. -These patch files should be named +<packagename>-<number>-<description>.patch+. - -A +series+ file, as used by +quilt+, may also be added in the -package directory. In that case, the +series+ file defines the patch -application order. +These patch files should be named +<number>-<description>.patch+. .Notes - The patch files coming with Buildroot should not contain any package version -reference in their filename. -- The field +<number>+ in the patch file name refers to the 'apply order'. + reference in their filename. +- 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+ +- 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 + not prefix patches with the package name.' +- Previously, a +series+ file, as used by +quilt+, could also be added in + the package directory. In that case, the +series+ file defines the patch + application order. This is deprecated, and will be removed in the future. + 'Do not use a series file.' + ==== Global patch directory
Signature · 1 line
1.9.1
Thomas Petazzoni
AppliedPATCH v2 1/1 docs/manual: document the new patch naming convention
Dear Yann E. MORIN,
Quoted 6 lines · Yann E. MORIN
To ease generating patches, we now use a naming convention that is in line with what git-format-patch does, that is:
- do not prefix patches with the package name
- prefix patches with a 4-digit mber
- start numbering at 0001
Quoted 6 lines
Signed-off-by "Yann E. MORIN" <[email protected]>Cc Peter Korsgaard <[email protected]>Cc Thomas Petazzoni <[email protected]>Cc Thomas De Schampheleire <[email protected]>Cc Arnout Vandecappelle <[email protected]>Cc Samuel Martin <[email protected]>
Applied, thanks!
Thomas
Signature · 3 lines
Thomas Petazzoni, CTO, Free Electrons Embedded Linux, Kernel and Android engineering http://free-electrons.com