NetCube-Systems-Austria/kumquat-buildroot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs/manual: clarify location of local.mk

Browse Source 
In particular, the manual was incorrect when the user had selected an
out-of-tree build.

Signed-off-by: Charlie Turner <cturner@igalia.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
(cherry picked from commit 59c3a4ff73)
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
This commit is contained in:
Charlie Turner 2019-05-13 11:37:42 +01:00 committed by Peter Korsgaard
parent da6cedbd76
commit 56f2a9d937
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/manual/using-buildroot-development.txt
View File

@ -28,10 +28,22 @@ clean+.
Therefore, Buildroot provides a specific mechanism for this use case:
the +<pkg>_OVERRIDE_SRCDIR+ mechanism. Buildroot reads an _override_
file, which allows the user to tell Buildroot the location of the
source for certain packages. By default this _override_ file is named
+local.mk+ and located in the top directory of the Buildroot source
tree, but a different location can be specified through the
+BR2_PACKAGE_OVERRIDE_FILE+ configuration option.
source for certain packages.
The default location of the override file is +$(CONFIG_DIR)/local.mk+,
as defined by the +BR2_PACKAGE_OVERRIDE_FILE+ configuration option.
+$(CONFIG_DIR)+ is the location of the Buildroot +.config+ file, so
+local.mk+ by default lives side-by-side with the +.config+ file,
which means:
* In the top-level Buildroot source directory for in-tree builds
(i.e., when +O=+ is not used)
* In the out-of-tree directory for out-of-tree builds (i.e., when
+O=+ is used)
If a different location than these defaults is required, it can be
specified through the +BR2_PACKAGE_OVERRIDE_FILE+ configuration
option.
In this _override_ file, Buildroot expects to find lines of the form: