From 9ff1b789e3d1b13894d89ea2707915e2f32f4700 Mon Sep 17 00:00:00 2001 From: rillig Date: Sat, 9 Jul 2016 14:44:06 +0000 Subject: Removed outdated text about license handling. Replaced difficult wording with simple words. Restructured the sections, for quicker access. --- doc/guide/files/fixes.xml | 77 ++++++++++++++++++++++++++--------------------- 1 file changed, 43 insertions(+), 34 deletions(-) (limited to 'doc/guide') diff --git a/doc/guide/files/fixes.xml b/doc/guide/files/fixes.xml index c8129659977..7ad1da0a109 100644 --- a/doc/guide/files/fixes.xml +++ b/doc/guide/files/fixes.xml @@ -1,4 +1,4 @@ - + Making your package work @@ -88,33 +88,22 @@ INTERACTIVE_STAGE= configure install Handling licenses - Authors of software can choose the licence under which - software can be copied. This is due to copyright law, and reasons - for license choices are outside the scope of pkgsrc. The pkgsrc - system recognizes that there are a number of licenses which some - users may find objectionable or difficult or impossible to comply - with. The Free Software Foundation has declared some licenses - "Free", and the Open Source Initiative has a definition of "Open - Source". The pkgsrc system, as a policy choice, does not label - packages which have licenses that are Free or Open Source. - However, packages without a license meeting either of those tests - are labeled with a license tag denoting the license. Note that a - package with no license to copy trivially does not meet either the - Free or Open Source test. - - For packages which are not Free or Open Source, pkgsrc will - not build the package unless the user has indicated to pkgsrc that - packages with that particular license may be built. Note that - this documentation avoids the term "accepted the license". The - pkgsrc system is merely providing a mechanism to avoid - accidentally building a package with a non-free license; - judgement and responsibility remain with the user. (Installation - of binary packages are not currently subject to this mechanism; - this is a bug.) + Authors of software can choose the licence under which software + can be copied. The Free Software Foundation has declared some + licenses "Free", and the Open Source Initiative has a definition of + "Open Source". + + By default, pkgsrc allows packages with Free or Open Source + licenses to be built. To allow packages with other licenses to be + built as well, the pkgsrc user needs to add these licenses to the + ACCEPTABLE_LICENSES variable in &mk.conf;. Note + that this variable only affects which packages may be + built, while the license terms often also + restrict the actual use of the package and its redistribution. One might want to only install packages with a BSD license, or the GPL, and not the other. The free licenses are added to the - default ACCEPTABLE_LICENSES variable. The + default ACCEPTABLE_LICENSES variable. The pkgsrc user can override the default by setting the ACCEPTABLE_LICENSES variable with "=" instead of "+=". The licenses accepted by default are: @@ -200,10 +189,31 @@ LICENSE= xv-license ACCEPTABLE_LICENSES+=xv-license + The use of LICENSE=shareware, + LICENSE=no-commercial-use, and similar language + is deprecated because it does not crisply refer to a particular + license text. Another problem with such usage is that it does not + enable a user to tell pkgsrc to proceed for a single package + without also telling pkgsrc to proceed for all packages with that + tag. + + + Adding a package with a new license + When adding a package with a new license, the following steps are required: - Check if the file can avoid the -license filename tag as described above by referencing Various Licenses and Comments about Them and Licenses by Name | Open Source Initiative. If this is the case, additionally add the license filename to: + + Check whether the license qualifies as Free or Open + Source by referencing Various Licenses + and Comments about Them and Licenses by Name | + Open Source Initiative. If this is the case, the filename in + pkgsrc/licenses/ does not need the + -license suffix, and the license name should be + added to: + DEFAULT_ACCEPTABLE_LICENSES in pkgsrc/mk/license.mk default_acceptable_licenses in pkgsrc/pkgtools/pkg_install/files/lib/license.c @@ -212,6 +222,11 @@ ACCEPTABLE_LICENSES+=xv-license with the proper syntax as demonstrated in those files, respectively. The license text should be added to pkgsrc/licenses for displaying. A list of known licenses can be seen in this directory. + + + + Change to the license + When the license changes (in a way other than formatting), please make sure that the new license has a different name (e.g., append the version number if it exists, or the date). Just @@ -221,14 +236,8 @@ ACCEPTABLE_LICENSES+=xv-license pkgsrc does not evaluate licenses for reasonableness; the only test is a mechanistic test of whether a particular text has been approved by either of two bodies. - - The use of LICENSE=shareware, - LICENSE=no-commercial-use, and similar language - is deprecated because it does not crisply refer to a particular - license text. Another problem with such usage is that it does not - enable a user to tell pkgsrc to proceed for a single package - without also telling pkgsrc to proceed for all packages with that - tag. + + Restricted packages -- cgit v1.2.3