Commit a373ad02 authored by Thomas De Schampheleire's avatar Thomas De Schampheleire Committed by Thomas Petazzoni
Browse files

manual/user guide/customization: change recommendation for package paths 



The Buildroot manual was recommending following paths for project-specific
packages:
    package/<company>/<boardname>/foo/
    $BR2_EXTERNAL/package/<boardname>/foo/

However, if a company has several boards, it is often the case that some
packages are common for different boards. Therefore, introducing a
<boardname> path component is not ideal.

This patch changes the recommendation to:
    package/<company>/foo/
    $BR2_EXTERNAL/package/foo/

Signed-off-by: default avatarThomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: default avatarThomas Petazzoni <thomas.petazzoni@free-electrons.com>
parent 69a5343b

docs/manual/customize-directory-structure.txt

+6 −7
Original line number Diff line number Diff line
@@ -40,7 +40,6 @@ it using +BR2_EXTERNAL+. Both options are valid, the choice is up to you. 
|   +-- <company>/

|       +-- Config.in (if not using BR2_EXTERNAL)

|       +-- <company>.mk (if not using BR2_EXTERNAL)

|       +-- <boardname>/

|       +-- package1/

|       |    +-- Config.in

|       |    +-- package1.mk

docs/manual/customize-outside-br.txt

+7 −5
Original line number Diff line number Diff line
@@ -81,19 +81,21 @@ The main usage of this is to store package recipes. The recommended 
   looks like:

+

------

source "$BR2_EXTERNAL/package/<boardname>/package1/Config.in"

source "$BR2_EXTERNAL/package/<boardname>/package2/Config.in"

source "$BR2_EXTERNAL/package/package1/Config.in"

source "$BR2_EXTERNAL/package/package2/Config.in"

------

+

Then, have a +$(BR2_EXTERNAL)/external.mk+ file that looks like:

+

------

include $(sort $(wildcard $(BR2_EXTERNAL)/package/*/*/*.mk))

include $(sort $(wildcard $(BR2_EXTERNAL)/package/*/*.mk))

------

+

And then in +$(BR2_EXTERNAL)/package/<boardname>/package1+ and

   +$(BR2_EXTERNAL)/package/<boardname>/package2+ create normal Buildroot

And then in +$(BR2_EXTERNAL)/package/package1+ and

   +$(BR2_EXTERNAL)/package/package2+ create normal Buildroot

   package recipes, as explained in xref:adding-packages[].

   If you prefer, you can also group the packages in subdirectories

   called <boardname> and adapt the above paths accordingly.



 * One can store Buildroot defconfigs in the +configs+ subdirectory of

   +$(BR2_EXTERNAL)+. Buildroot will automatically show them in the