aboutsummaryrefslogtreecommitdiff
path: root/doc/configuration/repositories/e.html.part
blob: 93ede77b19e288d0a3796808bf0cc60acfe894f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->

<h1>e Repository Format</h1>

<p>The <code>e</code> repository format is used on Gentoo and derived distributions for repositories containing ebuilds,
and on Exherbo for repositories containing exheres packages. Except where noted, all options described below are common
to both distributions.</p>

<p>As well as the <a href="index.html">general keys supported for all repositories</a>, the following keys have meaning
for <code>e</code> format repositories:</p>

<dl>
    <dt><code>location</code></dt>
    <dd>The location of the repository. Mandatory.</dd>

    <dt><code>master_repository</code></dt>
    <dd>If set to the name of another e-format repository, that repository is used as a 'master' for any part of
    this repository that is not defined. Also changes the default importance of this repository from 0 to 10.  (In
    Portage terms, this is similar to saying that this repository is an overlay with the master as the main repository.
    However, identically named and versioned packages in this repository do not hide those in the master.)
    Exheres repositories describe their own masters, so this option does not apply to them.</dd>

    <dt><code>profiles</code></dt>
    <dd>A space separated list of directories to use as profiles. Later entries override earlier entries. Inherited from
    a master if unspecified, mandatory otherwise. (In Portage terms, this is like the <code>/etc/make.profile</code>
    symlink.)</dd>

    <dt><code>eclassdirs</code></dt>
    <dd>A space separated list of directories in which to find eclasses. The first directory is used to set
    <code>ECLASSDIR</code>, but eclasses in later directories have priority. Optional, and not used by
    Exheres repositories.</dd>

    <dt><code>distdir</code></dt>
    <dd>Where to look for and save downloaded files. Inherited from a master. Optional.</dd>

    <dt><code>setsdir</code></dt>
    <dd>Where to look for repository-defined sets. Optional.</dd>

    <dt><code>securitydir</code></dt>
    <dd>Where to look for GLSAs (security advisories). Optional.</dd>

    <dt><code>newsdir</code></dt>
    <dd>Where to look for GLEP 42 news items. Optional.</dd>

    <dt><code>cache</code></dt>
    <dd>Where to look for read-only repository defined metadata cache items. If set to <code>/var/empty</code>, no
    repository defined cache is used. Optional.</dd>

    <dt><code>write_cache</code></dt>
    <dd>Where to look for and save generated metadata cache items. If set to <code>/var/empty</code>, no write cache is
    used. Optional, but recommended for repositories that do not ship with their own metadata cache.</dd>

    <dt><code>append_repository_name_to_write_cache</code></dt>
    <dd>Boolean. If true (default), the repository name is appended to the <code>write_cache</code> directory. Optional,
    for internal use.</dd>

    <dt><code>ignore_deprecated_profiles</code></dt>
    <dd>Boolean. If true (default is false), profiles deprecated files are ignored. Optional,
    for internal use.</dd>

    <dt><code>eapi_when_unknown</code></dt>
    <dd>The EAPI to use when a package's EAPI is unknown (e.g. before it has been sourced to generate its metadata, if
    it does not use an EAPI filename suffix). Optional, generally set by the distribution.</dd>

    <dt><code>eapi_when_unspecified</code></dt>
    <dd>The EAPI to use when a package does not specify an EAPI, either explicitly or by suffix. Optional, generally set
    by the distribution.</dd>

    <dt><code>profile_eapi_when_unspecified</code></dt>
    <dd>The EAPI to use for profiles when unspecified. Optional, generally set by the distribution.</dd>

    <dt><code>names_cache</code></dt>
    <dd>The directory in which to look for a names cache, and in which to generate a names cache. A names cache will
    significantly speed up converting a <code>pkg</code> into a <code>cat/pkg</code>. See <a
        href="../../overview/gettingstarted.html">Getting Started</a> for notes. Optional.</dd>

    <dt><code>sync</code></dt>
    <dd>How to sync the repository. See <a href="../syncers.html">Syncers</a> for supported formats. Optional if the
    repository does not need to be synced. Different sync URIs to use when a different source is requested may be
    specified, e.g. <code>sync = git+http://host/path local: git+file:///path</code>.</dd>

    <dt><code>sync_options</code></dt>
    <dd>Any options to be passed to the syncer. Optional. Options for alternative sources are specified using the same format as
    for <code>sync</code>.</dd>

    <dt><code>builddir</code></dt>
    <dd>The temporary directory to use when building packages. Optional.</dd>

    <dt><code>layout</code></dt>
    <dd>The repository's layout. Supported values are <code>traditional</code> and <code>exheres</code>. Optional,
    usually set by the distribution.</dd>

    <dt><code>use_manifest</code></dt>
    <dd>Whether to use Manifest2. Valid values are <code>use</code>, <code>require</code> or <code>ignore</code>.
    Optional.</dd>

    <dt><code>binary_destination</code></dt>
    <dd>If set to <code>true</code>, this repository is treated as a destination when creating binary packages.</dd>

    <dt><code>binary_uri_prefix</code></dt>
    <dd>When writing URIs for the binary tarball, the value of this setting is prepended to the tarball name. Typically
    this setting can be ignored for local-only binary packages, and should be set to something like
    <code>http://yourserver/bindistdir/</code> or <code>mirror://yourreponame/</code> for binary repositories that are
    to be distributed.</dd>

    <dt><code>binary_distdir</code></dt>
    <dd>Controls where binary package tarballs are written.</dd>

    <dt><code>binary_keywords_filter</code></dt>
    <dd>When deciding upon keywords for a binary package, the keywords of the origin package are unioned with the
    keywords in this setting. A typical value is <code>amd64 ~amd64</code>.</dd>
</dl>