diff options
authorGravatar Luca Ceresoli <luca@lucaceresoli.net>2015-10-03 23:18:21 +0200
committerGravatar Thomas Petazzoni <thomas.petazzoni@free-electrons.com>2015-10-04 17:04:16 +0100
commitad9c7ee554bb8b6f69429e8d1585d0555a42f06c (patch)
parenteb5e5b49d63123f20f2d1fdea56d304c44376f76 (diff)
docs/manual: document new actual source package variables
Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
index 40798c0283..9d6401ff02 100644
--- a/docs/manual/adding-packages-generic.txt
+++ b/docs/manual/adding-packages-generic.txt
@@ -388,6 +388,25 @@ information is (assuming the package name is +libfoo+) :
to let you know, and +not saved+ will appear in the +license files+ field
of the manifest file for this package.
+* +LIBFOO_ACTUAL_SOURCE_TARBALL+ only applies to packages whose
+ +LIBFOO_SITE+ / +LIBTOO_SOURCE+ pair points to an archive that does
+ not actually contain source code, but binary code. This a very
+ uncommon case, only known to apply to external toolchains which come
+ already compiled, although theoretically it might apply to other
+ packages. In such cases a separate tarball is usually available with
+ the actual source code. Set +LIBFOO_ACTUAL_SOURCE_TARBALL+ to the
+ name of the actual source code archive and Buildroot will download
+ it and use it when you run +make legal-info+ to collect
+ legally-relevant material. Note this file will not be downloaded
+ during regular builds nor by +make source+.
+* +LIBFOO_ACTUAL_SOURCE_SITE+ provides the location of the actual
+ source tarball. The default value is +LIBFOO_SITE+, so you don't
+ need to set this variable if the binary and source archives are
+ hosted on the same directory. If +LIBFOO_ACTUAL_SOURCE_TARBALL+ is
+ not set, it doesn't make sense to define
* +LIBFOO_REDISTRIBUTE+ can be set to +YES+ (default) or +NO+ to indicate if
the package source code is allowed to be redistributed. Set it to +NO+ for
non-opensource packages: Buildroot will not save the source code for this