2012-11-11 04:14:58 +01:00
|
|
|
// -*- mode:doc; -*-
|
2013-02-13 13:59:02 +01:00
|
|
|
// vim: set syntax=asciidoc:
|
2012-11-11 04:14:58 +01:00
|
|
|
|
|
|
|
[[legal-info]]
|
|
|
|
|
manual: high-level restructuring
The structure of the buildroot manual is not always clear. There is a large
number of chapters, and some chapters seem to overlap. The distinction
between general usage and developer information is not always clear.
This patch restructures the manual into four large parts:
- getting started
- user guide
- developer guide
- appendix
Except for the names of these parts, the section names are not yet changed.
Content-wise there are no changes yet either. This will be handled in
subsequent patches.
In order to achieve the introduction of a new level 'parts' above
'chapters', the section indicators (=, ==, ===, ...) of several sections
have to be moved one level down. Additionally, the leveloffset indication to
asciidoc has to be removed. Finally, to maintain more or less the same level
of detail in the table of contents, the toc.section.depth attribute is
reduced as well. Note that for some sections, less detail is visible now.
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2014-08-12 22:20:06 +02:00
|
|
|
== Legal notice and licensing
|
2012-11-11 04:14:58 +01:00
|
|
|
|
manual: high-level restructuring
The structure of the buildroot manual is not always clear. There is a large
number of chapters, and some chapters seem to overlap. The distinction
between general usage and developer information is not always clear.
This patch restructures the manual into four large parts:
- getting started
- user guide
- developer guide
- appendix
Except for the names of these parts, the section names are not yet changed.
Content-wise there are no changes yet either. This will be handled in
subsequent patches.
In order to achieve the introduction of a new level 'parts' above
'chapters', the section indicators (=, ==, ===, ...) of several sections
have to be moved one level down. Additionally, the leveloffset indication to
asciidoc has to be removed. Finally, to maintain more or less the same level
of detail in the table of contents, the toc.section.depth attribute is
reduced as well. Note that for some sections, less detail is visible now.
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2014-08-12 22:20:06 +02:00
|
|
|
=== Complying with open source licenses
|
2012-11-11 04:14:58 +01:00
|
|
|
|
|
|
|
All of the end products of Buildroot (toolchain, root filesystem, kernel,
|
2012-11-27 12:59:16 +01:00
|
|
|
bootloaders) contain open source software, released under various licenses.
|
2012-11-11 04:14:58 +01:00
|
|
|
|
2012-11-27 12:59:16 +01:00
|
|
|
Using open source software gives you the freedom to build rich embedded
|
2012-11-16 05:54:19 +01:00
|
|
|
systems, choosing from a wide range of packages, but also imposes some
|
2012-11-11 04:14:58 +01:00
|
|
|
obligations that you must know and honour.
|
|
|
|
Some licenses require you to publish the license text in the documentation of
|
2012-11-16 05:54:19 +01:00
|
|
|
your product. Others require you to redistribute the source code of the
|
2012-11-11 04:14:58 +01:00
|
|
|
software to those that receive your product.
|
|
|
|
|
2012-11-16 05:54:19 +01:00
|
|
|
The exact requirements of each license are documented in each package, and
|
|
|
|
it is your responsibility (or that of your legal office) to comply with those
|
|
|
|
requirements.
|
2012-11-11 04:14:58 +01:00
|
|
|
To make this easier for you, Buildroot can collect for you some material you
|
2012-11-16 05:54:19 +01:00
|
|
|
will probably need. To produce this material, after you have configured
|
|
|
|
Buildroot with +make menuconfig+, +make xconfig+ or +make gconfig+, run:
|
2012-11-11 04:14:58 +01:00
|
|
|
|
|
|
|
--------------------
|
|
|
|
make legal-info
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
Buildroot will collect legally-relevant material in your output directory,
|
|
|
|
under the +legal-info/+ subdirectory.
|
|
|
|
There you will find:
|
|
|
|
|
|
|
|
* A +README+ file, that summarizes the produced material and contains warnings
|
|
|
|
about material that Buildroot could not produce.
|
|
|
|
* +buildroot.config+: this is the Buildroot configuration file that is usually
|
|
|
|
produced with +make menuconfig+, and which is necessary to reproduce the
|
|
|
|
build.
|
2013-11-12 09:48:01 +01:00
|
|
|
* The source code for all packages; this is saved in the +sources/+ and
|
|
|
|
+host-sources/+ subdirectories for target and host packages respectively.
|
|
|
|
The source code for packages that set +<PKG>_REDISTRIBUTE = NO+ will not be
|
|
|
|
saved.
|
2016-08-17 18:01:09 +02:00
|
|
|
Patches that were applied are also saved, along with a file named +series+
|
|
|
|
that lists the patches in the order they were applied. Patches are under the
|
|
|
|
same license as the files that they modify.
|
2016-08-17 18:01:10 +02:00
|
|
|
Note: Buildroot applies additional patches to Libtool scripts of
|
|
|
|
autotools-based packages. These patches can be found under
|
|
|
|
+support/libtool+ in the Buildroot source and, due to technical
|
|
|
|
limitations, are not saved with the package sources. You may need to
|
|
|
|
collect them manually.
|
2013-11-12 09:48:01 +01:00
|
|
|
* A manifest file (one for host and one for target packages) listing the
|
|
|
|
configured packages, their version, license and related information.
|
2012-11-16 05:54:19 +01:00
|
|
|
Some of this information might not be defined in Buildroot; such items are
|
2012-11-27 12:59:16 +01:00
|
|
|
marked as "unknown".
|
2013-11-12 09:48:01 +01:00
|
|
|
* The license texts of all packages, in the +licenses/+ and +host-licenses/+
|
|
|
|
subdirectories for target and host packages respectively.
|
2012-11-11 04:14:58 +01:00
|
|
|
If the license file(s) are not defined in Buildroot, the file is not produced
|
|
|
|
and a warning in the +README+ indicates this.
|
|
|
|
|
|
|
|
Please note that the aim of the +legal-info+ feature of Buildroot is to
|
|
|
|
produce all the material that is somehow relevant for legal compliance with the
|
|
|
|
package licenses. Buildroot does not try to produce the exact material that
|
2012-11-16 05:54:19 +01:00
|
|
|
you must somehow make public. Certainly, more material is produced than is
|
2012-11-11 04:14:58 +01:00
|
|
|
needed for a strict legal compliance. For example, it produces the source code
|
2012-11-27 12:59:16 +01:00
|
|
|
for packages released under BSD-like licenses, that you are not required to
|
2012-11-11 04:14:58 +01:00
|
|
|
redistribute in source form.
|
|
|
|
|
|
|
|
Moreover, due to technical limitations, Buildroot does not produce some
|
2020-01-18 17:18:19 +01:00
|
|
|
material that you will or may need, such as the toolchain source code for
|
|
|
|
some of the external toolchains and the Buildroot source code itself.
|
2012-11-11 04:14:58 +01:00
|
|
|
When you run +make legal-info+, Buildroot produces warnings in the +README+
|
|
|
|
file to inform you of relevant material that could not be saved.
|
|
|
|
|
2016-10-01 17:26:32 +02:00
|
|
|
Finally, keep in mind that the output of +make legal-info+ is based on
|
|
|
|
declarative statements in each of the packages recipes. The Buildroot
|
|
|
|
developers try to do their best to keep those declarative statements as
|
|
|
|
accurate as possible, to the best of their knowledge. However, it is very
|
|
|
|
well possible that those declarative statements are not all fully accurate
|
|
|
|
nor exhaustive. You (or your legal department) _have_ to check the output
|
|
|
|
of +make legal-info+ before using it as your own compliance delivery. See
|
|
|
|
the _NO WARRANTY_ clauses (clauses 11 and 12) in the +COPYING+ file at the
|
|
|
|
root of the Buildroot distribution.
|
|
|
|
|
2016-03-01 12:01:04 +01:00
|
|
|
[[legal-info-buildroot]]
|
manual: high-level restructuring
The structure of the buildroot manual is not always clear. There is a large
number of chapters, and some chapters seem to overlap. The distinction
between general usage and developer information is not always clear.
This patch restructures the manual into four large parts:
- getting started
- user guide
- developer guide
- appendix
Except for the names of these parts, the section names are not yet changed.
Content-wise there are no changes yet either. This will be handled in
subsequent patches.
In order to achieve the introduction of a new level 'parts' above
'chapters', the section indicators (=, ==, ===, ...) of several sections
have to be moved one level down. Additionally, the leveloffset indication to
asciidoc has to be removed. Finally, to maintain more or less the same level
of detail in the table of contents, the toc.section.depth attribute is
reduced as well. Note that for some sections, less detail is visible now.
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2014-08-12 22:20:06 +02:00
|
|
|
=== Complying with the Buildroot license
|
2012-11-11 04:14:58 +01:00
|
|
|
|
2012-11-27 12:59:16 +01:00
|
|
|
Buildroot itself is an open source software, released under the
|
2016-03-01 12:01:04 +01:00
|
|
|
http://www.gnu.org/licenses/old-licenses/gpl-2.0.html[GNU General
|
|
|
|
Public License, version 2] or (at your option) any later version, with
|
|
|
|
the exception of the package patches detailed below.
|
2012-11-11 04:14:58 +01:00
|
|
|
However, being a build system, it is not normally part of the end product:
|
|
|
|
if you develop the root filesystem, kernel, bootloader or toolchain for a
|
|
|
|
device, the code of Buildroot is only present on the development machine, not
|
|
|
|
in the device storage.
|
|
|
|
|
|
|
|
Nevertheless, the general view of the Buildroot developers is that you should
|
|
|
|
release the Buildroot source code along with the source code of other packages
|
|
|
|
when releasing a product that contains GPL-licensed software.
|
|
|
|
This is because the
|
|
|
|
http://www.gnu.org/licenses/old-licenses/gpl-2.0.html[GNU GPL]
|
|
|
|
defines the "'complete source code'" for an executable work as "'all the
|
|
|
|
source code for all modules it contains, plus any associated interface
|
|
|
|
definition files, plus the scripts used to control compilation and installation
|
|
|
|
of the executable'".
|
|
|
|
Buildroot is part of the 'scripts used to control compilation and
|
|
|
|
installation of the executable', and as such it is considered part of the
|
|
|
|
material that must be redistributed.
|
|
|
|
|
2012-11-16 05:54:19 +01:00
|
|
|
Keep in mind that this is only the Buildroot developers' opinion, and you
|
|
|
|
should consult your legal department or lawyer in case of any doubt.
|
2016-03-01 12:01:04 +01:00
|
|
|
|
|
|
|
==== Patches to packages
|
|
|
|
|
|
|
|
Buildroot also bundles patch files, which are applied to the sources
|
|
|
|
of the various packages. Those patches are not covered by the license
|
|
|
|
of Buildroot. Instead, they are covered by the license of the software
|
|
|
|
to which the patches are applied. When said software is available
|
|
|
|
under multiple licenses, the Buildroot patches are only provided under
|
|
|
|
the publicly accessible licenses.
|
|
|
|
|
|
|
|
See xref:patch-policy[] for the technical details.
|