Skip to contentSkip to conversation

docs/manual: centralize recommendations about BR2_DL_DIR

PATCH New Luca Ceresoli 2 participants 2 messages Feb 6, 2017 – Feb 7, 2017

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/manual: centralize recommendations about BR2_DL_DIR

We currently have two places where we recommend where BR2_DL_DIR should be set: "Environment variables" and "Location of downloaded packages". The former recommends setting BR2_DL_DIR in the .config, the latter kind of endorses using ~/.bashrc.

We prefer suggesting the ~/.bashrc way since it avoids downloading the same file multiple times, and anyway ot's wise to have all the details in a unique place. So remove the .config suggestion from "Environment variables" and let it just point to "Location of downloaded packages".

Cc "Yann E. MORIN" <[email protected]>
---
 docs/manual/common-usage.txt      | 5 +++--
 docs/manual/download-location.txt | 2 ++
 2 files changed, 5 insertions(+), 2 deletions(-)
docs/manual/common-usage.txt +3 -2
index 7602260bab4f..8dd99a6dacc3 100644
@@ -91,8 +91,9 @@ to +make+ or set in the environment:
   Buildroot stores/retrieves downloaded files
   +
   Note that the Buildroot download directory can also be set from the
-  configuration interface, so through the Buildroot +.config+ file; this
-  is the recommended way of setting it.
+  configuration interface, so through the Buildroot +.config+ file. See
+  xref:download-location[] for more details on how you can set the download
+  directory.
 * +BR2_GRAPH_ALT+, if set and non-empty, to use an alternate color-scheme in
   build-time graphs
 * +BR2_GRAPH_OUT+ to set the filetype of generated graphs, either +pdf+ (the
docs/manual/download-location.txt +2 -0
index 0b53f54ca14e..d485df94f59a 100644
@@ -1,6 +1,8 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
+[[download-location]]
+
 ==== Location of downloaded packages
 
 The various tarballs that are downloaded by Buildroot are all stored
Signature · 1 line
2.7.4
#1 lore raw

PATCH 1/1 docs/manual: centralize recommendations about BR2_DL_DIR

Quoted 7 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

"Luca" == Luca Ceresoli <[email protected]> writes:

We currently have two places where we recommend where BR2_DL_DIR should be set: "Environment variables" and "Location of downloaded packages". The former recommends setting BR2_DL_DIR in the .config, the latter kind of endorses using ~/.bashrc.

Quoted 7 lines

We prefer suggesting the ~/.bashrc way since it avoids downloading the same file multiple times, and anyway ot's wise to have all the details in a unique place. So remove the .config suggestion from "Environment variables" and let it just point to "Location of downloaded packages".

Cc "Yann E. MORIN" <[email protected]>

Committed, thanks.

Signature · 1 line
Bye, Peter Korsgaard