| 1 | GLEP: 60 |
1 | GLEP: 60 |
| 2 | Title: Manifest2 filetypes |
2 | Title: Manifest2 filetypes |
| 3 | Version: $Revision: 1.6 $ |
3 | Version: $Revision: 1.7 $ |
| 4 | Last-Modified: $Date: 2010/01/13 00:54:50 $ |
4 | Last-Modified: $Date: 2010/01/13 03:26:53 $ |
| 5 | Author: Robin Hugh Johnson <robbat2@gentoo.org> |
5 | Author: Robin Hugh Johnson <robbat2@gentoo.org> |
| 6 | Status: Draft |
6 | Status: Draft |
| 7 | Type: Standards Track |
7 | Type: Standards Track |
| 8 | Content-Type: text/x-rst |
8 | Content-Type: text/x-rst |
| 9 | Requires: 44 |
9 | Requires: 44 |
| … | |
… | |
| 33 | unless stated otherwise in the following sections. The Manifest file |
33 | unless stated otherwise in the following sections. The Manifest file |
| 34 | must not contain an entry for itself. |
34 | must not contain an entry for itself. |
| 35 | |
35 | |
| 36 | Excluded files |
36 | Excluded files |
| 37 | -------------- |
37 | -------------- |
| 38 | When generating or validating a Manifest, or commiting to a version |
38 | When generating or validating a Manifest, or committing to a version |
| 39 | control system, the package manager should endeavour to ignore files |
39 | control system, the package manager should endeavour to ignore files |
| 40 | created by a version control system, backup files from text editors. A |
40 | created by a version control system, backup files from text editors. A |
| 41 | non-exhaustive list is suggested here: ``CVS/``, ``.svn/``, ``.bzr/``, |
41 | non-exhaustive list is suggested here: ``CVS/``, ``.svn/``, ``.bzr/``, |
| 42 | ``.git/``, ``.hg/``, ``.#*``, ``*.rej``, ``*.orig``, ``*.bak``, ``*~``. |
42 | ``.git/``, ``.hg/``, ``.#*``, ``*.rej``, ``*.orig``, ``*.bak``, ``*~``. |
| 43 | |
43 | |
| … | |
… | |
| 125 | MANIFEST (new) |
125 | MANIFEST (new) |
| 126 | ~~~~~~~~~~~~~~ |
126 | ~~~~~~~~~~~~~~ |
| 127 | - The MANIFEST type is explicitly to cover all nested Manifest files. |
127 | - The MANIFEST type is explicitly to cover all nested Manifest files. |
| 128 | - During validation, this serves as an indicator that the package |
128 | - During validation, this serves as an indicator that the package |
| 129 | manager may need to check subtree Manifest file. |
129 | manager may need to check subtree Manifest file. |
| 130 | - A missing MANIFEST file may be treated as a minor (eg excluding an |
130 | - A missing MANIFEST file may be treated as a minor (e.g. excluding an |
| 131 | entire category) or critical validation failure. |
131 | entire category) or critical validation failure. |
| 132 | - The failure should be considered as critical only if files that would |
132 | - The failure should be considered as critical only if files that would |
| 133 | be directly covered by this Manifest are missing. Deletion of a |
133 | be directly covered by this Manifest are missing. Deletion of a |
| 134 | category-level Manifest while preserving the packages is forbidden. |
134 | category-level Manifest while preserving the packages is forbidden. |
| 135 | Deletion of an entire category is not. |
135 | Deletion of an entire category is not. |
| … | |
… | |
| 147 | |
147 | |
| 148 | EXEC (new) |
148 | EXEC (new) |
| 149 | ~~~~~~~~~~ |
149 | ~~~~~~~~~~ |
| 150 | - uses _CRIT. |
150 | - uses _CRIT. |
| 151 | - If the file gets sourced, executed, or causes a change (patches) in |
151 | - If the file gets sourced, executed, or causes a change (patches) in |
| 152 | how something is sourced or execututed, it belongs in the EXEC |
152 | how something is sourced or executed, it belongs in the EXEC |
| 153 | filetype. |
153 | filetype. |
| 154 | - This filetype should be used for the scripts directories of a |
154 | - This filetype should be used for the scripts directories of a |
| 155 | repository for important files. |
155 | repository for important files. |
| 156 | - This filetype is not limited to being used in the files/ |
156 | - This filetype is not limited to being used in the files/ |
| 157 | subdirectory. |
157 | subdirectory. |
| … | |
… | |
| 194 | => MISC, stop. |
194 | => MISC, stop. |
| 195 | 9. not matched by any other rule |
195 | 9. not matched by any other rule |
| 196 | => OTHER, stop. |
196 | => OTHER, stop. |
| 197 | |
197 | |
| 198 | The logic behind 5, 6, 7 is ensuring that every item that by it's |
198 | The logic behind 5, 6, 7 is ensuring that every item that by it's |
| 199 | presence or absense may be dangerous should always be treated strictly. |
199 | presence or absence may be dangerous should always be treated strictly. |
| 200 | (Consider epatch given a directory of patches ``${FILESDIR}/${PV}/``, |
200 | (Consider epatch given a directory of patches ``${FILESDIR}/${PV}/``, |
| 201 | where it blindly includes them, or alternatively, the package.mask file |
201 | where it blindly includes them, or alternatively, the package.mask file |
| 202 | or a profile being altered/missing). |
202 | or a profile being altered/missing). |
| 203 | |
203 | |
| 204 | The above lists of file patterns are not intended to be exhaustive, |
204 | The above lists of file patterns are not intended to be exhaustive, |
| … | |
… | |
| 230 | .. [#GLEP44] Mauch, M. (2005) GLEP44 - Manifest2 format. |
230 | .. [#GLEP44] Mauch, M. (2005) GLEP44 - Manifest2 format. |
| 231 | http://www.gentoo.org/proj/en/glep/glep-0044.html |
231 | http://www.gentoo.org/proj/en/glep/glep-0044.html |
| 232 | |
232 | |
| 233 | Copyright |
233 | Copyright |
| 234 | ========= |
234 | ========= |
| 235 | Copyright (c) 2007 by Robin Hugh Johnson. This material may be |
235 | Copyright (c) 2007-2010 by Robin Hugh Johnson. This material may be |
| 236 | distributed only subject to the terms and conditions set forth in the |
236 | distributed only subject to the terms and conditions set forth in the |
| 237 | Open Publication License, v1.0. |
237 | Open Publication License, v1.0. |
| 238 | |
238 | |
| 239 | vim: tw=72 ts=2 expandtab: |
239 | vim: tw=72 ts=2 expandtab: |