Skip to contentSkip to conversation

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

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

lore
Share & tools
lore
#0 lore raw

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

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.

Cc Baruch Siach <[email protected]>
Cc Ricardo Herrero <[email protected]>
---
 docs/manual/adding-packages-generic.txt | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
docs/manual/adding-packages-generic.txt +6 -5
index 0e111e1199de..a08283c5a39d 100644
@@ -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.
Signature · 1 line
2.7.4
#1 lore raw

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

Quoted 10 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

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

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.

Cc Baruch Siach <[email protected]>
Cc Ricardo Herrero <[email protected]>

Committed, thanks.

Signature · 1 line
Bye, Peter Korsgaard