en/glep/glep-0060.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
  <title>GLEP 60 -- Manifest2 filetypes</title>
  <link rel="stylesheet" href="tools/glep.css" type="text/css" /></head>
<body bgcolor="white">
<table class="navigation" cellpadding="0" cellspacing="0"
       width="100%" border="0">
<tr><td class="navicon" width="150" height="35">
<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
 border="0" width="150" height="35" /></a></td>
<td class="textlinks" align="left">
[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0060.txt">GLEP Source</a></b>]
</td></tr></table>
<table class="rfc2822 docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">60</td>
</tr>
<tr class="field"><th class="field-name">Title:</th><td class="field-body">Manifest2 filetypes</td>
</tr>
<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.8</td>
</tr>
<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference external" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0060.txt?cvsroot=gentoo">2010/01/31 07:56:58</a></td>
</tr>
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Robin Hugh Johnson &lt;robbat2&#32;&#97;t&#32;gentoo.org&gt;</td>
</tr>
<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
</tr>
<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
</tr>
<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference external" href="glep-0002.html">text/x-rst</a></td>
</tr>
<tr class="field"><th class="field-name">Requires:</th><td class="field-body"><a class="reference external" href="http://www.gentoo.org/proj/en/glepglep-0044.html">44</a></td>
</tr>
<tr class="field"><th class="field-name">Created:</th><td class="field-body">November 2007</td>
</tr>
<tr class="field"><th class="field-name">Updated:</th><td class="field-body">June 2008, July 2008, October 2008, January 2010</td>
</tr>
<tr class="field"><th class="field-name">Updates:</th><td class="field-body">44</td>
</tr>
<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">December 2009, January 2010</td>
</tr>
</tbody>
</table>
<hr />
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#abstract" id="id4">Abstract</a></li>
<li><a class="reference internal" href="#motivation" id="id5">Motivation</a></li>
<li><a class="reference internal" href="#specification" id="id6">Specification</a><ul>
<li><a class="reference internal" href="#general" id="id7">General</a></li>
<li><a class="reference internal" href="#excluded-files" id="id8">Excluded files</a></li>
<li><a class="reference internal" href="#existing-filetypes" id="id9">Existing filetypes:</a><ul>
<li><a class="reference internal" href="#aux" id="id10">AUX</a></li>
<li><a class="reference internal" href="#ebuild" id="id11">EBUILD</a></li>
<li><a class="reference internal" href="#dist" id="id12">DIST</a></li>
<li><a class="reference internal" href="#misc" id="id13">MISC</a></li>
</ul>
</li>
<li><a class="reference internal" href="#new-filetypes" id="id14">New filetypes:</a><ul>
<li><a class="reference internal" href="#info-new-abstract" id="id15">_INFO (new, abstract)</a></li>
<li><a class="reference internal" href="#crit-new-abstract" id="id16">_CRIT (new, abstract)</a></li>
<li><a class="reference internal" href="#id1" id="id17">EBUILD</a></li>
<li><a class="reference internal" href="#id2" id="id18">DIST</a></li>
<li><a class="reference internal" href="#id3" id="id19">MISC</a></li>
<li><a class="reference internal" href="#manifest-new" id="id20">MANIFEST (new)</a></li>
<li><a class="reference internal" href="#eclass-new" id="id21">ECLASS (new)</a></li>
<li><a class="reference internal" href="#data-new" id="id22">DATA (new)</a></li>
<li><a class="reference internal" href="#exec-new" id="id23">EXEC (new)</a></li>
<li><a class="reference internal" href="#other-new" id="id24">OTHER (new)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#on-bloat" id="id25">On Bloat</a></li>
<li><a class="reference internal" href="#chosing-a-filetype" id="id26">Chosing a filetype</a></li>
</ul>
</li>
<li><a class="reference internal" href="#backwards-compatibility" id="id27">Backwards Compatibility</a></li>
<li><a class="reference internal" href="#thanks-to" id="id28">Thanks to</a></li>
<li><a class="reference internal" href="#references" id="id29">References</a></li>
<li><a class="reference internal" href="#copyright" id="id30">Copyright</a></li>
</ul>
</div>
<div class="section" id="abstract">
<h1><a class="toc-backref" href="#id4">Abstract</a></h1>
<p>Clarification of the Manifest2 [#GLEP44] specification, including new types to
help in the tree-signing specification.</p>
</div>
<div class="section" id="motivation">
<h1><a class="toc-backref" href="#id5">Motivation</a></h1>
<p>[#GLEP44] was not entirely clear on the usage of filetype specifiers.
This document serves to provide some of the internal logic used by
Portage at the point of writing, as well as adding new types to cover
the rest of the tree, for the purposes of tree-signing coverage.</p>
<p>This GLEP is not mandatory for the tree-signing specification, but
instead aims to clarify the usage of the Manifest2 filetype specifiers,
and note which types signify files that are allowed to be missing from
the tree (e.g. a user excluding a package or category).</p>
</div>
<div class="section" id="specification">
<h1><a class="toc-backref" href="#id6">Specification</a></h1>
<div class="section" id="general">
<h2><a class="toc-backref" href="#id7">General</a></h2>
<p>For any given directory with a Manifest file, every file located in that
directory, or a sub-directory must be listed in that Manifest file,
unless stated otherwise in the following sections. The Manifest file
must not contain an entry for itself.</p>
</div>
<div class="section" id="excluded-files">
<h2><a class="toc-backref" href="#id8">Excluded files</a></h2>
<p>When generating or validating a Manifest, or committing to a version
control system, the package manager should endeavour to ignore files
created by a version control system, backup files from text editors. A
non-exhaustive list is suggested here: <tt class="docutils literal">CVS/</tt>, <tt class="docutils literal">.svn/</tt>, <tt class="docutils literal">.bzr/</tt>,
<tt class="docutils literal">.git/</tt>, <tt class="docutils literal">.hg/</tt>, <tt class="docutils literal">.#*</tt>, <tt class="docutils literal">*.rej</tt>, <tt class="docutils literal">*.orig</tt>, <tt class="docutils literal">*.bak</tt>, <tt class="docutils literal">*~</tt>.</p>
<p>Additionally, for a transitional Manifest1-&gt;Manifest2 system, old-style
digest files located in a 'files/' directory, may be excluded from
Manifest2 generation, or included with a type of MISC.</p>
<p>Under strict security conditions, the exclusion list may be ignored
during validation if the existence of a file would be considered a
security risk.</p>
</div>
<div class="section" id="existing-filetypes">
<h2><a class="toc-backref" href="#id9">Existing filetypes:</a></h2>
<div class="section" id="aux">
<h3><a class="toc-backref" href="#id10">AUX</a></h3>
<ul class="simple">
<li>The AUX type is used for all items under the 'files' subdirectory.</li>
<li>They should be verified relative to $FILESDIR.</li>
<li>The string 'files/' is left out of the Manifest line.</li>
<li>The absence of a file mentioned by AUX must be treated as an error.</li>
<li>The AUX type is intended to denote potentially executable content
(either directly or indirectly), that must be treated an error if
modified or absent.</li>
</ul>
</div>
<div class="section" id="ebuild">
<h3><a class="toc-backref" href="#id11">EBUILD</a></h3>
<ul class="simple">
<li>The EBUILD type is used solely for files ending in .ebuild, or other
suffixes as defined by the EAPI.</li>
<li>The files are located in the same directory as the Manifest file.</li>
<li>The modification or absence of a file mentioned by EBUILD must be
treated as an error.</li>
</ul>
</div>
<div class="section" id="dist">
<h3><a class="toc-backref" href="#id12">DIST</a></h3>
<ul class="simple">
<li>The DIST type is used for distfiles</li>
<li>They may be found directly via the $DISTDIR setting of the package
manager.</li>
<li>During simple verification of a Manifest, a missing DIST file should
not be consider as a validation error (it is however a failure to
fetch or unpack).</li>
</ul>
</div>
<div class="section" id="misc">
<h3><a class="toc-backref" href="#id13">MISC</a></h3>
<ul class="simple">
<li>The MISC type covers all remaining files in a directory.</li>
<li>MISC is intended to mark all content that was not used in
some way that directly affected execution of the package manager.</li>
<li>This includes metadata.xml and ChangeLog entries, and any other purely
informational content.</li>
<li>MISC entries where the file is missing may optionally be ignored as by
non-strict package managers.</li>
<li>It should be possible to install a package while all MISC entries have
been deleted from the tree.</li>
</ul>
</div>
</div>
<div class="section" id="new-filetypes">
<h2><a class="toc-backref" href="#id14">New filetypes:</a></h2>
<div class="section" id="info-new-abstract">
<h3><a class="toc-backref" href="#id15">_INFO (new, abstract)</a></h3>
<ul class="simple">
<li>This is the functionality of the old AUX, but does not include the
implicit 'files/' prefix in the path, and is verified relative to the
working directory instead of $FILESDIR.</li>
<li>The modification or absence of a file listed as a _INFO-derived type
is not an error unless the package manager is attempting to be strict.</li>
</ul>
</div>
<div class="section" id="crit-new-abstract">
<h3><a class="toc-backref" href="#id16">_CRIT (new, abstract)</a></h3>
<ul class="simple">
<li>_CRIT is based off the _INFO type.</li>
<li>The modification or absence of a file listed as a _CRIT-derived type
MUST be treated as an error.</li>
</ul>
</div>
<div class="section" id="id1">
<h3><a class="toc-backref" href="#id17">EBUILD</a></h3>
<ul class="simple">
<li>Now derived from _CRIT.</li>
<li>Otherwise unchanged.</li>
</ul>
</div>
<div class="section" id="id2">
<h3><a class="toc-backref" href="#id18">DIST</a></h3>
<ul class="simple">
<li>Now derived from _CRIT.</li>
<li>Otherwise unchanged.</li>
</ul>
</div>
<div class="section" id="id3">
<h3><a class="toc-backref" href="#id19">MISC</a></h3>
<ul class="simple">
<li>Now derived from _INFO.</li>
<li>Otherwise unchanged.</li>
</ul>
</div>
<div class="section" id="manifest-new">
<h3><a class="toc-backref" href="#id20">MANIFEST (new)</a></h3>
<ul class="simple">
<li>The MANIFEST type is explicitly to cover all nested Manifest files.</li>
<li>During validation, this serves as an indicator that the package
manager may need to check subtree Manifest file.</li>
<li>A missing MANIFEST file may be treated as a minor (e.g. excluding an
entire category) or critical validation failure.</li>
<li>The failure should be considered as critical only if files that would
be directly covered by this Manifest are missing. Deletion of a
category-level Manifest while preserving the packages is forbidden.
Deletion of an entire category is not.</li>
</ul>
</div>
<div class="section" id="eclass-new">
<h3><a class="toc-backref" href="#id21">ECLASS (new)</a></h3>
<ul class="simple">
<li>uses _CRIT.</li>
<li>This type shall be used for all eclasses only.</li>
</ul>
</div>
<div class="section" id="data-new">
<h3><a class="toc-backref" href="#id22">DATA (new)</a></h3>
<ul class="simple">
<li>uses _CRIT.</li>
<li>The DATA type shall be used for all files that directly affect the
package manager, such as metadata/cache/* and profiles/.</li>
</ul>
</div>
<div class="section" id="exec-new">
<h3><a class="toc-backref" href="#id23">EXEC (new)</a></h3>
<ul class="simple">
<li>uses _CRIT.</li>
<li>If the file gets sourced, executed, or causes a change (patches) in
how something is sourced or executed, it belongs in the EXEC
filetype.</li>
<li>This filetype should be used for the scripts directories of a
repository for important files.</li>
<li>This filetype is not limited to being used in the files/
subdirectory.</li>
</ul>
</div>
<div class="section" id="other-new">
<h3><a class="toc-backref" href="#id24">OTHER (new)</a></h3>
<ul class="simple">
<li>uses _CRIT.</li>
<li>All other files that are not covered by another type should be
considered as 'OTHER'.</li>
<li>Any further new filetypes should be introduced to subtract files
from the 'OTHER' set.</li>
<li>If a package manager runs into a unknown Manifest2 type, it should
be treated as 'OTHER'.</li>
</ul>
</div>
</div>
<div class="section" id="on-bloat">
<h2><a class="toc-backref" href="#id25">On Bloat</a></h2>
<p>If repeated use of a common path prefix is considered a bloat problem, a
Manifest file should be added inside the common directory, however this
should not be done blindly, as bloat by inodes is more significant for
the majority of use cases. See also [#GLEP58] on size reductions of
Manifests.</p>
</div>
<div class="section" id="chosing-a-filetype">
<h2><a class="toc-backref" href="#id26">Chosing a filetype</a></h2>
<ol class="arabic">
<li><dl class="first docutils">
<dt>matches <tt class="docutils literal">Manifest</tt></dt>
<dd><p class="first last">=&gt; MANIFEST, stop.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>matches <tt class="docutils literal">*.ebuild</tt></dt>
<dd><p class="first last">=&gt; EBUILD, stop.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>matches <tt class="docutils literal">*.eclass</tt></dt>
<dd><p class="first last">=&gt; ECLASS, stop.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>listed in SRC_URI</dt>
<dd><p class="first last">=&gt; DIST, stop.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>matches <tt class="docutils literal">files/*</tt></dt>
<dd><p class="first last">=&gt; AUX, continue [see note].</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>matches any of <tt class="docutils literal">*.sh</tt>, <tt class="docutils literal">*.bashrc</tt>, <tt class="docutils literal">*.patch</tt>, ...</dt>
<dd><p class="first last">=&gt; EXEC, stop.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>matches any of <tt class="docutils literal">metadata/cache/*</tt>, <tt class="docutils literal">profiles/</tt>, <tt class="docutils literal">package.*</tt>, <tt class="docutils literal">use.mask*</tt>, ...</dt>
<dd><p class="first last">=&gt; DATA, stop.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>matches any of <tt class="docutils literal">ChangeLog</tt>, <tt class="docutils literal">metadata.xml</tt>, <tt class="docutils literal">*.desc</tt>, ...</dt>
<dd><p class="first last">=&gt; MISC, stop.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>not matched by any other rule</dt>
<dd><p class="first last">=&gt; OTHER, stop.</p>
</dd>
</dl>
</li>
</ol>
<p>The logic behind 5, 6, 7 is ensuring that every item that by it's
presence or absence may be dangerous should always be treated strictly.
(Consider epatch given a directory of patches <tt class="docutils literal"><span class="pre">${FILESDIR}/${PV}/</span></tt>,
where it blindly includes them, or alternatively, the package.mask file
or a profile being altered/missing).</p>
<p>The above lists of file patterns are not intended to be exhaustive,
but merely demonstrative.</p>
<p>Note: The AUX entries should only be generated if we are generating a
compatible Manifest that supports older versions of Portage. They should
be generated along with the new type.</p>
</div>
</div>
<div class="section" id="backwards-compatibility">
<h1><a class="toc-backref" href="#id27">Backwards Compatibility</a></h1>
<p>For generation of existing package Manifests, the AUX entries must
continue to be present for the standard Portage deprecation cycle.
The new entries may be included already in all Manifest files, as they
will be ignored by older Portage versions. Over time, ECLASS, DATA,
EXEC, OTHER may replace the existing AUX type.</p>
<p>The adoption of this proposal does also affect [#GLEP58] as part of
this GLEP series, however this GLEP was an offset of the research in
that GLEP.</p>
</div>
<div class="section" id="thanks-to">
<h1><a class="toc-backref" href="#id28">Thanks to</a></h1>
<p>I'd like to thank the following people for input on this GLEP.
- Marius Mauch (genone) &amp; Zac Medico (zmedico): Portage Manifest2</p>
</div>
<div class="section" id="references">
<h1><a class="toc-backref" href="#id29">References</a></h1>
<table class="docutils footnote" frame="void" id="glep44" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label">[1]</td><td>Mauch, M. (2005) GLEP44 - Manifest2 format.
<a class="reference external" href="http://www.gentoo.org/proj/en/glep/glep-0044.html">http://www.gentoo.org/proj/en/glep/glep-0044.html</a></td></tr>
</tbody>
</table>
</div>
<div class="section" id="copyright">
<h1><a class="toc-backref" href="#id30">Copyright</a></h1>
<p>Copyright (c) 2007-2010 by Robin Hugh Johnson. This material may be
distributed only subject to the terms and conditions set forth in the
Open Publication License, v1.0.</p>
<p>vim: tw=72 ts=2 expandtab:</p>
</div>

</div>
<div class="footer">
<hr class="footer" />
<a class="reference external" href="glep-0060.txt">View document source</a>.
Generated on: 2010-01-31 08:27 UTC.
Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.

</div>
</body>
</html>