diff mbox

[14/16,v5] core/legal-info: allow ignoring packages from the legal-info

Message ID 96aee606d5d79d7867fc7d60c5343e0b827ff795.1457718289.git.yann.morin.1998@free.fr
State Changes Requested
Headers show

Commit Message

Yann E. MORIN March 11, 2016, 5:49 p.m. UTC
It might be necessary to not even mention a package in the output of
legal-info:

  - virtual packages have virtually nothing to save in the legal-info
    output;

  - for Buildroot itself, host-gcc-initial and host-gcc-final are
    not real packages, they are just two different steps of the same
    package, gcc;

  - for proprietary packages, it might not even be legal to even
    mention them, being under NDA or some other such restrictive
    conditions.

Introduce the new FOO_LEGAL_INGORE variable that a package can set
to 'YES' (default to 'NO') to indicate that the package should be
completely ignored from the legal-info output, in which case the
package is not mentioned in the maniufest, its source archive,
patches and license files are not saved into legal-info/ .

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Luca Ceresoli <luca@lucaceresoli.net>
Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Cc: Peter Korsgaard <jacmet@uclibc.org>
Reviewed-by: Luca Ceresoli <luca@lucaceresoli.net>
Tested-by: Luca Ceresoli <luca@lucaceresoli.net>

---
Changes v1 -> v2:
  - introduce a new variable, instead of making _REDISTRIBUTE a
    tri-state  (Thomas, Peter, Luca)
---
 docs/manual/adding-packages-generic.txt |  9 +++++++++
 package/pkg-generic.mk                  | 15 +++++++++++++++
 2 files changed, 24 insertions(+)

Comments

Thomas Petazzoni March 19, 2016, 3:29 p.m. UTC | #1
Dear Yann E. MORIN,

On Fri, 11 Mar 2016 18:49:27 +0100, Yann E. MORIN wrote:
> It might be necessary to not even mention a package in the output of
> legal-info:
> 
>   - virtual packages have virtually nothing to save in the legal-info
>     output;
> 
>   - for Buildroot itself, host-gcc-initial and host-gcc-final are
>     not real packages, they are just two different steps of the same
>     package, gcc;
> 
>   - for proprietary packages, it might not even be legal to even
>     mention them, being under NDA or some other such restrictive
>     conditions.

What is the difference with <pkg>_REDISTRIBUTE = NO ? I know
REDISTRIBUTE = NO packages are mentioned in legal-info, but their
source code is not copied to the legal-info stuff.

But does it make sense to have two separate things? Why do REDISTRIBUTE
= NO packages get mentioned in the legal-info if their source code is
anyway not saved.

> Introduce the new FOO_LEGAL_INGORE variable that a package can set

typoe: IGNORE

> to 'YES' (default to 'NO') to indicate that the package should be
> completely ignored from the legal-info output, in which case the
> package is not mentioned in the maniufest, its source archive,

typo: manifest

> patches and license files are not saved into legal-info/ .
> 
> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
> Cc: Luca Ceresoli <luca@lucaceresoli.net>
> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
> Cc: Peter Korsgaard <jacmet@uclibc.org>
> Reviewed-by: Luca Ceresoli <luca@lucaceresoli.net>
> Tested-by: Luca Ceresoli <luca@lucaceresoli.net>
> 
> ---
> Changes v1 -> v2:
>   - introduce a new variable, instead of making _REDISTRIBUTE a
>     tri-state  (Thomas, Peter, Luca)

Ah, we discussed using REDISTRIBUTE, I remember. But do we need a
tri-state ? Do we really have REDISTRIBUTE = NO packages that we want
to see mentioned in the legal-info output ?

> +* +LIBFOO_LEGAL_IGNORE+ can be set to +YES+ or +NO+ (the default) to indicate

To me, the naming of the variable looks like inverted logic. What about:

LIBFOO_SAVE_LEGAL_INFO = YES (default) / NO

but obviously, <pkg>_SAVE_LEGAL_INFO is a bit confusing with
<pkg>_REDISTRIBUTE.

Best regards,

Thomas
Yann E. MORIN March 19, 2016, 11:48 p.m. UTC | #2
Thomas, All,

On 2016-03-19 16:29 +0100, Thomas Petazzoni spake thusly:
> On Fri, 11 Mar 2016 18:49:27 +0100, Yann E. MORIN wrote:
> > It might be necessary to not even mention a package in the output of
> > legal-info:
> > 
> >   - virtual packages have virtually nothing to save in the legal-info
> >     output;
> > 
> >   - for Buildroot itself, host-gcc-initial and host-gcc-final are
> >     not real packages, they are just two different steps of the same
> >     package, gcc;
> > 
> >   - for proprietary packages, it might not even be legal to even
> >     mention them, being under NDA or some other such restrictive
> >     conditions.
> 
> What is the difference with <pkg>_REDISTRIBUTE = NO ? I know
> REDISTRIBUTE = NO packages are mentioned in legal-info, but their
> source code is not copied to the legal-info stuff.

"FOO_LEGAL_IGNORE = YES" mnens that the package will not even be listed
in the manifest.

Sometimes, there are (proprietary) packages that are under NDA, and even
the mere hint at the use of that package is forbidden. So we need to be
able to represent that situation.

> But does it make sense to have two separate things? Why do REDISTRIBUTE
> = NO packages get mentioned in the legal-info if their source code is
> anyway not saved.

Because the license may require it? For example, the boot codes for the
RPi are BSD-licensed, so we have to provide the license file, so
rpi-firmware has to be in the manifest. But we do not have the source
for those blobs...

[--SNIP--]
Typoes fixed, thanks.

> > patches and license files are not saved into legal-info/ .
> > 
> > Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
> > Cc: Luca Ceresoli <luca@lucaceresoli.net>
> > Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
> > Cc: Peter Korsgaard <jacmet@uclibc.org>
> > Reviewed-by: Luca Ceresoli <luca@lucaceresoli.net>
> > Tested-by: Luca Ceresoli <luca@lucaceresoli.net>
> > 
> > ---
> > Changes v1 -> v2:
> >   - introduce a new variable, instead of making _REDISTRIBUTE a
> >     tri-state  (Thomas, Peter, Luca)
> 
> Ah, we discussed using REDISTRIBUTE, I remember. But do we need a
> tri-state ? Do we really have REDISTRIBUTE = NO packages that we want
> to see mentioned in the legal-info output ?

Yes, see above.

> > +* +LIBFOO_LEGAL_IGNORE+ can be set to +YES+ or +NO+ (the default) to indicate
> 
> To me, the naming of the variable looks like inverted logic. What about:
> 
> LIBFOO_SAVE_LEGAL_INFO = YES (default) / NO
> 
> but obviously, <pkg>_SAVE_LEGAL_INFO is a bit confusing with
> <pkg>_REDISTRIBUTE.

Yes, I am not completely sold on the _LEGAL_IGNORE name, but your
proposal is not better IMHO...

Regards,
Yann E. MORIN.
diff mbox

Patch

diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
index 8ed7fe8..5cf2ae0 100644
--- a/docs/manual/adding-packages-generic.txt
+++ b/docs/manual/adding-packages-generic.txt
@@ -430,6 +430,15 @@  information is (assuming the package name is +libfoo+) :
   non-opensource packages: Buildroot will not save the source code for this
   package when collecting the +legal-info+.
 
+* +LIBFOO_LEGAL_IGNORE+ can be set to +YES+ or +NO+ (the default) to indicate
+  that this package should be completely ignored when saving the licensing
+  information. If set to +YES+, then the package is not listed in the manifest,
+  its source archive and its license files are not saved. You probably do not
+  want to set it to +YES+, unless under very specific conditions (e.g. when
+  you use the `legal-info/` output directory as-is to provide a compliance
+  delivery, and do not want your proprietary, non-redistributable packages to
+  even be mentioned in the manifest).
+
 * +LIBFOO_FLAT_STACKSIZE+ defines the stack size of an application built into
   the FLAT binary format. The application stack size on the NOMMU architecture
   processors can't be enlarged at run time. The default stack size for the
diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
index bc39ead..3a5ad83 100644
--- a/package/pkg-generic.mk
+++ b/package/pkg-generic.mk
@@ -496,6 +496,14 @@  endif
 
 $(2)_REDISTRIBUTE		?= YES
 
+ifndef $(2)_LEGAL_IGNORE
+ ifdef $(3)_LEGAL_IGNORE
+  $(2)_LEGAL_IGNORE = $$($(3)_LEGAL_IGNORE)
+ endif
+endif
+
+$(2)_LEGAL_IGNORE		?= NO
+
 $(2)_REDIST_SOURCES_DIR = $$(REDIST_SOURCES_DIR_$$(call UPPERCASE,$(4)))/$$($(2)_RAWNAME_VERSION)
 
 # When a target package is a toolchain dependency set this variable to
@@ -781,7 +789,10 @@  $(2)_MANIFEST_LICENSE_FILES ?= not saved
 # We need to extract and patch a package to be able to retrieve its
 # license files (if any) and the list of patches applied to it (if
 # any).
+# But not if we want to ignore that package completely.
+ifneq ($$($(2)_LEGAL_IGNORE),YES)
 $(1)-legal-info: $(1)-patch
+endif
 
 # We only save the sources of packages we want to redistribute, that are
 # non-overriden (local or true override).
@@ -794,6 +805,8 @@  endif
 
 # legal-info: produce legally relevant info.
 $(1)-legal-info:
+ifneq ($$($(2)_LEGAL_IGNORE),YES)
+
 # Packages without a source are assumed to be part of Buildroot, skip them.
 	$$(foreach hook,$$($(2)_PRE_LEGAL_INFO_HOOKS),$$(call $$(hook))$$(sep))
 ifneq ($$(call qstrip,$$($(2)_SOURCE)),)
@@ -847,6 +860,8 @@  endif # other packages
 endif # ifneq ($$(call qstrip,$$($(2)_SOURCE)),)
 	$$(foreach hook,$$($(2)_POST_LEGAL_INFO_HOOKS),$$(call $$(hook))$$(sep))
 
+endif # $(2)_LEGAL_IGNORE != YES
+
 # add package to the general list of targets if requested by the buildroot
 # configuration
 ifeq ($$($$($(2)_KCONFIG_VAR)),y)