/[gentoo]/xml/htdocs/proj/en/glep/glep-0023.txt
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0023.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.1 Revision 1.6
1GLEP: 23 1GLEP: 23
2Title: Portage handling of ACCEPT_LICENSE 2Title: Handling of ACCEPT_LICENSE
3Version: $Revision: 1.1 $ 3Version: $Revision: 1.6 $
4Last-Modified: $Date: 2004/03/08 17:26:04 $ 4Last-Modified: $Date: 2006/11/19 22:50:15 $
5Author: Jason Stubbs <jstubbs@gentoo.org>, 5Author: Jason Stubbs <jstubbs@gentoo.org>, Marius Mauch <genone@gentoo.org>
6Status: Draft 6Status: Accepted
7Type: Standards Track 7Type: Standards Track
8Content-Type: text/x-rst 8Content-Type: text/x-rst
9Created: 9-Mar-2004 9Created: 9-Mar-2004
10Post-History: 8-Mar-2004 10Post-History: 8-Mar-2004 10-Mar-2004 25-Oct-2004 18-Nov-2006 19-Nov-2006
11 11
12 12
13Abstract 13Abstract
14======== 14========
15 15
16Currently, every ebuild in the portage tree is required to have a valid 16Currently, every ebuild in the main gentoo repository is required to have a
17LICENSE entry. However, the syntax of this entry is not officially 17valid LICENSE entry. However, the syntax of this entry is not officially
18defined and the entry itself is only used when outputting package 18defined and the entry itself is only used when outputting package
19details. 19details.
20 20
21Status Update
22=============
23
24Repoman has been updated to check for the LICENSE syntax.
25A development portage branch with support for ACCEPT_LICENSE
26and license groups exists.
21 27
22Motivation 28Motivation
23========== 29==========
24 30
25Many users wish to regulate the software they install with regards to 31Many users wish to regulate the software they install with regards to
55functionality offered by a DEPEND string. To keep things simple, this 61functionality offered by a DEPEND string. To keep things simple, this
56GLEP proposes that the syntax be identical. For example: 62GLEP proposes that the syntax be identical. For example:
57 63
58:: 64::
59 65
60 LICENSE="mandatory-license \ 66 LICENSE="mandatory-license
61 ( || choosable-licence1 chooseable-license-2 ) \ 67 || ( choosable-licence1 chooseable-license-2 )
62 useflag? ( optional-component-license )" 68 useflag? ( optional-component-license )"
63 69
70
71License names may contain [a-zA-Z0-9] (english alphanumeric characters),
72_ (underscore), - (dash), . (dot) and + (plus sign).
64 73
65License Groups 74License Groups
66-------------- 75--------------
67 76
68Almost all users are willing to install any software that is 77Almost all users are willing to install any software that is
69OSI-approved. Other users are willing to install any software and 78FSF-approved. Other users are willing to install any software and
70implicitly accept its license. To this end, portage will also need to 79implicitly accept its license. To this end, implementations will also
71handle grouping of licenses. 80need to handle grouping of licenses.
72 81
73At a minimum, there needs to be the groups ``OSI-APPROVED`` and 82At a minimum, there needs to be the groups ``GPL-COMPATIBLE``,
74``NON-INTERACTIVE``. ``NON-INTERACTIVE`` licenses are those that don't 83``FSF-APPROVED``, ``OSI-APPROVED`` and ``NON-MUST-HAVE-READ``.
75require interactive acceptance for it to be considered legally binding. 84``NON-MUST-HAVE-READ`` licenses are those that don't require manual
76This is the current behaviour of portage. 85acceptance for to be considered legally binding. This is the current
86behaviour of portage.
87
88These groups are defined in a new file ``license_groups`` in
89the ``profiles`` subdirectory of the tree (or overlays).
90Details of handling groups defined in overlays is implementation dependent.
91
92The format of this file is
93
94::
95
96 <groupname> <license1> <license2> ... <licenseN>
97
98Also any line starting with # is ignored and may be used for comments.
99Group names use the same syntax as normal license names. Also license groups
100may contain other groups.
101License groups may not contain negated elements, so a group
102
103::
104
105 mygroup foo -bar -bla
106
107is illegal.
77 108
78 109
79ACCEPT_LICENSE 110ACCEPT_LICENSE
80-------------- 111--------------
81 112
92This GLEP proposes that the license group be prepended by the special 123This GLEP proposes that the license group be prepended by the special
93character "``@``". For example: 124character "``@``". For example:
94 125
95:: 126::
96 127
97 ACCEPT_LICENSE="-* @OSI-APPROVED" 128 ACCEPT_LICENSE="-* @FSF-APPROVED"
98 129
130License groups may be negated with the result that all elements of that group
131are also negated.
99 132
100Emerge Behaviour 133Portage will also offer a package.license facility to offer this functionality
101---------------- 134on a per-package base (analog to package.keywords), other implementations may
135implement such a facility differently or not at all.
102 136
103At a minimum, emerge must handle unaccepted licenses the same way that 137Behaviour
104it handles blockers. That is, with the --pretend flag the 138---------
105not-yet-accepted license should be listed in the output. Without the
106--pretend flag, emerge should stop before any software is installed.
107 139
108This GLEP proposes that, unlike blockers, dependencies for software 140Unaccepted licenses will be treated like any other masked package, that is
109should be checked regardless of license acceptance. Doing so will allow 141the user interface of an implementation will display a message listing any
110the user to review all necessary licenses before initiating an actual 142license that has to be accepted before the package can be merged with a
111emerge. 143pointer to the exact license text.
112 144
113It is also proposed that the --ask option will display an unaccepted 145Past versions of this document proposed to handle license-masked packages
114license and ask for acceptance, but not update any configuration files 146like blockers, but this would be inconsistent with other visibility
115at this stage. Finally, the --verbose option should also list the 147filters as well as the current blocker system (as a blocker affects two
116licenses accepted for each package. 148packages) and be more complicated to implement.
117
118 149
119Rationale 150Rationale
120========= 151=========
121 152
122An implementation of this proposal should make it easy for users wishing 153An implementation of this proposal should make it easy for users wishing
124 155
125 156
126Reference Implementation 157Reference Implementation
127======================== 158========================
128 159
129TODO 160Available in portage svn repository under main/branches/license-masking
130 161
131 162
132Backwards Compatibility 163Backwards Compatibility
133======================= 164=======================
134 165
135There should be no change to the user experience without the user 166There should be no change to the user experience without the user
136explicitly choosing to do so. This mandates that the 167explicitly choosing to do so. This mandates that the
137configuration variable be named ``ACCEPT_LICENSE`` as some users may 168configuration variable be named ``ACCEPT_LICENSE`` as some users may
138already have it set due to ebuilds using ``eutil.eclass``'s 169already have it set due to ebuilds using ``eutil.eclass``'s
139implementation. It also mandates that the default ``ACCEPT_LICENSE`` be 170implementation. It also mandates that the default ``ACCEPT_LICENSE`` be
140set to ``@NON-INTERACTIVE``. 171set to ``@NON-MUST-HAVE-READ`` in the main gentoo repository as implementations
141 172are not required to provide an internal default.
142 173
143References 174References
144========== 175==========
145 176
146.. [1] Gentoo Linux Bug 17367 177.. [1] Gentoo Linux Bug 17367

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.6

  ViewVC Help
Powered by ViewVC 1.1.20