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

docs/manual: suggest 'YES' as the value for LIBFOO_GIT_SUBMODULES

Browse Source 
The manual mentions LIBFOO_GIT_SUBMODULES but does not tell what value
it should have. The implementation only checks whether the variable is
non-empty, but we should suggest a specific value to avoid people
wondering what they have to set, and to try setting weird values.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Cc: Baruch Siach <baruch@tkos.co.il>
Cc: Ricardo Herrero <ricardo.herrero@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
This commit is contained in:
Luca Ceresoli 2017-02-07 12:08:17 +01:00 committed by Peter Korsgaard
parent 06216078f6
commit 428145838b
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/manual/adding-packages-generic.txt
View File

@ -317,11 +317,12 @@ information is (assuming the package name is +libfoo+) :
the package source code. Buildroot copies the contents of the
source directory into the package's build directory.
* +LIBFOO_GIT_SUBMODULES+, when +LIBFOO_SITE_METHOD=git+, will create
an archive with the git submodules in the repository.
Note that we try not to use such git submodules when they contain
bundled libraries, in which case we prefer to use those libraries
from their own package.
* +LIBFOO_GIT_SUBMODULES+ can be set to +YES+ to create an archive
with the git submodules in the repository. This is only available
for packages downloaded with git (i.e. when
+LIBFOO_SITE_METHOD=git+). Note that we try not to use such git
submodules when they contain bundled libraries, in which case we
prefer to use those libraries from their own package.
* +LIBFOO_STRIP_COMPONENTS+ is the number of leading components
(directories) that tar must strip from file names on extraction.