From 81bc106e080e56e2c85466ea7d4ecf38bc99149c Mon Sep 17 00:00:00 2001 From: Adam Joseph Date: Mon, 28 Mar 2022 20:51:34 -0700 Subject: meta.sourceProvenance documentation: clarify it is unaffected by changes to meta.license This commit clarifies that the meaning of the `meta.sourceProvenance` field is independent of and unaffected by the value of the `meta.license` field. This is based on the intent of the RFC author as expressed here: https://github.com/NixOS/nixpkgs/pull/161098#issuecomment-1081270201 This clarification is added for two reasons: 1. If in the future there should be some disagreement about what `sourceProvenance` to assign to a package, this may help resolve the disagreement. Any interpretation of `sourceProvenance` which is influenced by the `meta.license` is clearly an incorrect interpretation. 2. If it should turn out that it is impossible to disentangle `sourceProvenance` from `meta.license`, this would indicate the need for changes to the `sourceProvenance` scheme. That change might be as simple as replacing the sentence added by this commit with some other sentence explaining how the two fields influence each other. This commit implements the recommendation made in the paragraph of this comments which begins with "Please say this explicitly...": https://github.com/NixOS/nixpkgs/pull/161098#issuecomment-1081309089 --- doc/stdenv/meta.chapter.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc/stdenv') diff --git a/doc/stdenv/meta.chapter.md b/doc/stdenv/meta.chapter.md index 2b99a8abf5544..475006b1259b6 100644 --- a/doc/stdenv/meta.chapter.md +++ b/doc/stdenv/meta.chapter.md @@ -260,6 +260,8 @@ Adding this information helps users who have needs related to build transparency The presence of a particular `sourceType` in a package's `meta.sourceProvenance` list indicates that the package contains some components falling into that category, though the *absence* of that `sourceType` does not *guarantee* the absence of that category of `sourceType` in the package's contents. A package with no `meta.sourceProvenance` set implies it has no *known* `sourceType`s other than `fromSource`. +The meaning of the `meta.sourceProvenance` attribute does not depend on the value of the `meta.license` attribute. + ### `lib.sourceTypes.fromSource` {#lib.sourceTypes.fromSource} Package elements which are produced by a nixpkgs derivation which builds them from source code. -- cgit 1.4.1