Commit a5fd21d2 authored by Thomas Petazzoni's avatar Thomas Petazzoni
Browse files

docs/manual: update documentation about applying patches 



The Buildroot manual is currently wrong when describing how patches
are applied: it says that <packagename>-*.patch is applied, and that
<packagename>-<seq>-*.patch is the recommended name for patches. This
is incorrect, since we're now using just <seq>-*.patch. This commit
adjusts the documentation accordingly.

Signed-off-by: default avatarThomas Petazzoni <thomas.petazzoni@free-electrons.com>
Reviewed-by: default avatar"Yann E. MORIN" <yann.morin.1998@free.fr>
parent 0eba4759

docs/manual/adding-packages-generic.txt

+1 −1
Original line number Diff line number Diff line
@@ -219,7 +219,7 @@ information is (assuming the package name is +libfoo+) : 
  +LIBFOO_SITE+. If +HOST_LIBFOO_PATCH+ is not specified, it defaults

  to +LIBFOO_PATCH+. Note that patches that are included in Buildroot

  itself use a different mechanism: all files of the form

  +<packagename>-*.patch+ present in the package directory inside

  +*.patch+ present in the package directory inside

  Buildroot will be applied to the package after extraction (see

  xref:patch-policy[patching a package]). Finally, patches listed in

  the +LIBFOO_PATCH+ variable are applied _before_ the patches stored

docs/manual/customize-patches.txt

+5 −6
Original line number Diff line number Diff line
@@ -33,12 +33,11 @@ follows: 
* If a +series+ file exists in the package directory, then patches are

  applied according to the +series+ file;

+

* Otherwise, patch files matching +<packagename>-*.patch+

  are applied in alphabetical order.

  So, to ensure they are applied in the right order, it is highly

  recommended to name the patch files like this:

  +<packagename>-<number>-<description>.patch+, where +<number>+

  refers to the 'apply order'.

* Otherwise, patch files matching +*.patch+ are applied in

  alphabetical order.  So, to ensure they are applied in the right

  order, it is highly recommended to name the patch files like this:

  +<number>-<description>.patch+, where +<number>+ refers to the

  'apply order'.



For information about how patches are applied for a package, see

xref:patch-apply-order[]