docs/manual: clarify location of local.mk

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>
This commit is contained in:
Charlie Turner 2019-05-13 11:37:42 +01:00 committed by Thomas Petazzoni
parent cde99db79a
commit 59c3a4ff73

View File

@ -28,10 +28,22 @@ clean+.
Therefore, Buildroot provides a specific mechanism for this use case: Therefore, Buildroot provides a specific mechanism for this use case:
the +<pkg>_OVERRIDE_SRCDIR+ mechanism. Buildroot reads an _override_ the +<pkg>_OVERRIDE_SRCDIR+ mechanism. Buildroot reads an _override_
file, which allows the user to tell Buildroot the location of the file, which allows the user to tell Buildroot the location of the
source for certain packages. By default this _override_ file is named source for certain packages.
+local.mk+ and located in the top directory of the Buildroot source
tree, but a different location can be specified through the The default location of the override file is +$(CONFIG_DIR)/local.mk+,
+BR2_PACKAGE_OVERRIDE_FILE+ configuration option. 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: In this _override_ file, Buildroot expects to find lines of the form: