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

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

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

Revision 1.5 Revision 1.10
1GLEP: 60 1GLEP: 60
2Title: Manifest2 filetypes 2Title: Manifest2 filetypes
3Version: $Revision: 1.5 $ 3Version: $Revision: 1.10 $
4Last-Modified: $Date: 2010/01/13 00:48:23 $ 4Last-Modified: $Date: 2010/04/07 21:34:24 $
5Author: Robin Hugh Johnson <robbat2@gentoo.org> 5Author: Robin Hugh Johnson <robbat2@gentoo.org>
6Status: Draft 6Status: Draft
7Type: Standards Track 7Type: Standards Track
8Content-Type: text/x-rst 8Content-Type: text/x-rst
9Requires: 44 9Requires: 44
10Created: November 2007 10Created: November 2007
11Updated: June 2008, July 2008, October 2008 11Updated: June 2008, July 2008, October 2008, January 2010
12Updates: 44 12Updates: 44
13Post-History: 13Post-History: December 2009, January 2010
14 14
15Abstract 15Abstract
16======== 16========
17Clarification of the Manifest2 [#GLEP44] specification, including new types to 17Clarification of the Manifest2 [GLEP44] specification, including new types to
18help in the tree-signing specification. 18help in the tree-signing specification.
19 19
20Motivation 20Motivation
21========== 21==========
22[#GLEP44] was not entirely clear on the usage of filetype specifiers. 22[GLEP44] was not entirely clear on the usage of filetype specifiers.
23This document serves to provide some of the internal logic used by 23This document serves to provide some of the internal logic used by
24Portage at the point of writing, as well as adding new types to cover 24Portage at the point of writing, as well as adding new types to cover
25the rest of the tree, for the purposes of tree-signing coverage. 25the rest of the tree, for the purposes of tree-signing coverage.
26
27This GLEP is not mandatory for the tree-signing specification, but
28instead aims to clarify the usage of the Manifest2 filetype specifiers,
29and note which types signify files that are allowed to be missing from
30the tree (e.g. a user excluding a package or category). As such, it is
31also able to stand on it's own.
26 32
27Specification 33Specification
28============= 34=============
29General 35General
30------- 36-------
33unless stated otherwise in the following sections. The Manifest file 39unless stated otherwise in the following sections. The Manifest file
34must not contain an entry for itself. 40must not contain an entry for itself.
35 41
36Excluded files 42Excluded files
37-------------- 43--------------
38When generating or validating a Manifest, or commiting to a version 44When generating or validating a Manifest, or committing to a version
39control system, the package manager should endeavour to ignore files 45control system, the package manager should endeavour to ignore files
40created by a version control system, backup files from text editors. A 46created by a version control system, backup files from text editors. A
41non-exhaustive list is suggested here: ``CVS/``, ``.svn/``, ``.bzr/``, 47non-exhaustive list is suggested here: ``CVS/``, ``.svn/``, ``.bzr/``,
42``.git/``, ``.hg/``, ``.#*``, ``*.rej``, ``*.orig``, ``*.bak``, ``*~``. 48``.git/``, ``.hg/``, ``.#*``, ``*.rej``, ``*.orig``, ``*.bak``, ``*~``.
43 49
125MANIFEST (new) 131MANIFEST (new)
126~~~~~~~~~~~~~~ 132~~~~~~~~~~~~~~
127- The MANIFEST type is explicitly to cover all nested Manifest files. 133- The MANIFEST type is explicitly to cover all nested Manifest files.
128- During validation, this serves as an indicator that the package 134- During validation, this serves as an indicator that the package
129 manager may need to check subtree Manifest file. 135 manager may need to check subtree Manifest file.
130- A missing MANIFEST file may be treated as a minor (eg excluding an 136- A missing MANIFEST file may be treated as a minor (e.g. excluding an
131 entire category) or critical validation failure. 137 entire category) or critical validation failure.
132- The failure should be considered as critical only if files that would 138- The failure should be considered as critical only if files that would
133 be directly covered by this Manifest are missing. Deletion of a 139 be directly covered by this Manifest are missing. Deletion of a
134 category-level Manifest while preserving the packages is forbidden. 140 category-level Manifest while preserving the packages is forbidden.
135 Deletion of an entire category is not. 141 Deletion of an entire category is not.
147 153
148EXEC (new) 154EXEC (new)
149~~~~~~~~~~ 155~~~~~~~~~~
150- uses _CRIT. 156- uses _CRIT.
151- If the file gets sourced, executed, or causes a change (patches) in 157- If the file gets sourced, executed, or causes a change (patches) in
152 how something is sourced or execututed, it belongs in the EXEC 158 how something is sourced or executed, it belongs in the EXEC
153 filetype. 159 filetype.
154- This filetype should be used for the scripts directories of a 160- This filetype should be used for the scripts directories of a
155 repository for important files. 161 repository for important files.
156- This filetype is not limited to being used in the files/ 162- This filetype is not limited to being used in the files/
157 subdirectory. 163 subdirectory.
169On Bloat 175On Bloat
170-------- 176--------
171If repeated use of a common path prefix is considered a bloat problem, a 177If repeated use of a common path prefix is considered a bloat problem, a
172Manifest file should be added inside the common directory, however this 178Manifest file should be added inside the common directory, however this
173should not be done blindly, as bloat by inodes is more significant for 179should not be done blindly, as bloat by inodes is more significant for
174the majority of use cases. See also [#GLEP58] on size reductions of 180the majority of use cases. See also [GLEP58] on size reductions of
175Manifests. 181Manifests.
176 182
177Chosing a filetype 183Chosing a filetype
178------------------ 184------------------
1791. matches ``Manifest`` 1851. matches ``Manifest``
194 => MISC, stop. 200 => MISC, stop.
1959. not matched by any other rule 2019. not matched by any other rule
196 => OTHER, stop. 202 => OTHER, stop.
197 203
198The logic behind 5, 6, 7 is ensuring that every item that by it's 204The logic behind 5, 6, 7 is ensuring that every item that by it's
199presence or absense may be dangerous should always be treated strictly. 205presence or absence may be dangerous should always be treated strictly.
200(Consider epatch given a directory of patches ``${FILESDIR}/${PV}/``, 206(Consider epatch given a directory of patches ``${FILESDIR}/${PV}/``,
201where it blindly includes them, or alternatively, the package.mask file 207where it blindly includes them, or alternatively, the package.mask file
202or a profile being altered/missing). 208or a profile being altered/missing).
203 209
204The above lists of file patterns are not intended to be exhaustive, 210The above lists of file patterns are not intended to be exhaustive,
214continue to be present for the standard Portage deprecation cycle. 220continue to be present for the standard Portage deprecation cycle.
215The new entries may be included already in all Manifest files, as they 221The new entries may be included already in all Manifest files, as they
216will be ignored by older Portage versions. Over time, ECLASS, DATA, 222will be ignored by older Portage versions. Over time, ECLASS, DATA,
217EXEC, OTHER may replace the existing AUX type. 223EXEC, OTHER may replace the existing AUX type.
218 224
219The adoption of this proposal does also affect [#GLEP58] as part of 225The adoption of this proposal does also affect [GLEP58] as part of
220this GLEP series, however this GLEP was an offset of the research in 226this GLEP series, however this GLEP was an offset of the research in
221that GLEP. 227that GLEP.
222 228
223Thanks to 229Thanks to
224========= 230=========
225I'd like to thank the following people for input on this GLEP. 231I'd like to thank the following people for input on this GLEP.
226- Marius Mauch (genone) & Zac Medico (zmedico): Portage Manifest2 232- Marius Mauch (genone) & Zac Medico (zmedico): Portage Manifest2
227 233
228References 234References
229========== 235==========
230.. [#GLEP44] Mauch, M. (2005) GLEP44 - Manifest2 format. 236.. [GLEP44] Mauch, M. (2005) GLEP44 - Manifest2 format.
231 http://www.gentoo.org/proj/en/glep/glep-0044.html 237 http://www.gentoo.org/proj/en/glep/glep-0044.html
238
239.. [GLEP58] Security of distribution of Gentoo software - Infrastructure to User distribution - MetaManifest
240 http://www.gentoo.org/proj/en/glep/glep-0058.html
232 241
233Copyright 242Copyright
234========= 243=========
235Copyright (c) 2007 by Robin Hugh Johnson. This material may be 244Copyright (c) 2007-2010 by Robin Hugh Johnson. This material may be
236distributed only subject to the terms and conditions set forth in the 245distributed only subject to the terms and conditions set forth in the
237Open Publication License, v1.0. 246Open Publication License, v1.0.
238 247
239vim: tw=72 ts=2 expandtab: 248.. vim: tw=72 ts=2 expandtab:

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.10

  ViewVC Help
Powered by ViewVC 1.1.20