[Buildroot] [PATCH 1/1] docs/manual: Clarify location of local.mk

[Buildroot] [PATCH 1/1] docs/manual: Clarify location of local.mk

[Charlie Turner]

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

Signed-off-by: Charlie Turner <cturner@igalia.com>
---
 docs/manual/using-buildroot-development.txt | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/docs/manual/using-buildroot-development.txt b/docs/manual/using-buildroot-development.txt
index 3389a37b39..3e0f4be287 100644
--- a/docs/manual/using-buildroot-development.txt
+++ b/docs/manual/using-buildroot-development.txt
@@ -29,9 +29,18 @@ 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.
++local.mk+ and is located where your Buildroot configuration file is.
+By default this location is in the top-level directory of the
+buildroot source tree.
+
+However, if the user has selected an out-of-tree build (using the
++O=path/to/my_output_dir+ make option) then you should place +local.mk+ in
++path/to/my_output_dir+, since that is where this out-of-tree build's
++.config+ file is located.
+
+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:
 
-- 
2.17.1

[Buildroot] [PATCH 1/1] docs/manual: Clarify location of local.mk

[Thomas Petazzoni]

Hello Charlie,

On Mon, 13 May 2019 10:44:40 +0100
Charlie Turner <cturner@igalia.com> wrote:

> In particular, the manual was incorrect when the user had selected an
> out-of-tree build.
> 
> Signed-off-by: Charlie Turner <cturner@igalia.com>
> ---
>  docs/manual/using-buildroot-development.txt | 15 ++++++++++++---
>  1 file changed, 12 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/manual/using-buildroot-development.txt b/docs/manual/using-buildroot-development.txt
> index 3389a37b39..3e0f4be287 100644
> --- a/docs/manual/using-buildroot-development.txt
> +++ b/docs/manual/using-buildroot-development.txt
> @@ -29,9 +29,18 @@ 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.
> ++local.mk+ and is located where your Buildroot configuration file is.
> +By default this location is in the top-level directory of the
> +buildroot source tree.
> +
> +However, if the user has selected an out-of-tree build (using the
> ++O=path/to/my_output_dir+ make option) then you should place +local.mk+ in
> ++path/to/my_output_dir+, since that is where this out-of-tree build's
> ++.config+ file is located.
> +
> +If a different location than these defaults is required, it can be
> +specified through the +BR2_PACKAGE_OVERRIDE_FILE+ configuration
> +option.

Thanks for following up our conversation on IRC with an actual patch. I
would actually prefer a wording along the lines of:

"""
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.
"""

What do you think ?

Thomas
-- 
Thomas Petazzoni, CTO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

[Buildroot] [PATCH 1/1] docs/manual: Clarify location of local.mk

[Peter Korsgaard]

>>>>> "Charlie" == Charlie Turner <cturner@igalia.com> writes:

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

 > Signed-off-by: Charlie Turner <cturner@igalia.com>

Committed to 2019.02.x, thanks.

-- 
Bye, Peter Korsgaard

[Buildroot] [PATCH 1/1] docs/manual: Clarify location of local.mk

[Thomas Petazzoni]

On Mon, 13 May 2019 11:37:42 +0100
Charlie Turner <cturner@igalia.com> wrote:

> In particular, the manual was incorrect when the user had selected an
> out-of-tree build.
> 
> Signed-off-by: Charlie Turner <cturner@igalia.com>
> ---
>  docs/manual/using-buildroot-development.txt | 20 ++++++++++++++++----
>  1 file changed, 16 insertions(+), 4 deletions(-)

Applied to master, thanks.

Thomas
-- 
Thomas Petazzoni, CTO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

[Buildroot] [PATCH 1/1] docs/manual: Clarify location of local.mk

[Charlie Turner]

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

Signed-off-by: Charlie Turner <cturner@igalia.com>
---
 docs/manual/using-buildroot-development.txt | 20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)

diff --git a/docs/manual/using-buildroot-development.txt b/docs/manual/using-buildroot-development.txt
index 3389a37b39..65a9f1a3f7 100644
--- a/docs/manual/using-buildroot-development.txt
+++ b/docs/manual/using-buildroot-development.txt
@@ -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:
 
-- 
2.17.1