Commit ad9c7ee5 authored by Luca Ceresoli's avatar Luca Ceresoli Committed by Thomas Petazzoni
Browse files

docs/manual: document new actual source package variables 



Signed-off-by: default avatarLuca Ceresoli <luca@lucaceresoli.net>
Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com>
Cc: Arnout Vandecappelle <arnout@mind.be>
Signed-off-by: default avatarThomas Petazzoni <thomas.petazzoni@free-electrons.com>
parent eb5e5b49

docs/manual/adding-packages-generic.txt

+19 −0
Original line number Diff line number Diff line
@@ -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_ACTUAL_SOURCE_SITE+.



* +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