deepcrayon/buildroot
deepcrayon/buildroot
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

docs/manual: document the new patch naming convention

Browse source 
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" <yann.morin.1998@free.fr>
Cc: Peter Korsgaard <jacmet@uclibc.org>
Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com>
Cc: Arnout Vandecappelle <arnout@mind.be>
Cc: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
This commit is contained in:
Yann E. MORIN 2014-12-05 19:06:24 +01:00 committed by Thomas Petazzoni
parent 093a4f4fc4
commit 8e7d179f83
1 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/manual/patch-policy.txt
View file

@ -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