aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-23 18:36:48 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-23 18:36:48 +0000
commit689db7516fab7a9271110a62bb843bcdc3490ebf (patch)
tree94d3faea3cd535a857c62d99fada35a71069c638
parent71a5b310ad9eddbaac35feef45eb6d5e6e582b6c (diff)
downloadpaludis-689db7516fab7a9271110a62bb843bcdc3490ebf.tar.gz
paludis-689db7516fab7a9271110a62bb843bcdc3490ebf.tar.xz
erepository
-rw-r--r--doc/configuration/Makefile.am19
-rw-r--r--doc/configuration/erepository.html.part.in84
2 files changed, 100 insertions, 3 deletions
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index ac53274..0577843 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -34,7 +34,9 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \
configfiles.html \
specs.html \
repositories.html \
- repositories.html.part
+ repositories.html.part \
+ erepository.html \
+ erepository.html.part
MAINTAINERCLEANFILES = Makefile.in
@@ -57,7 +59,8 @@ EXTRA_DIST = \
configfiles.html.part \
specs.html.part \
sets.html.part.in \
- repositories.html.part.in
+ repositories.html.part.in \
+ erepository.html.part.in
paludisconfigurationhtmldir = $(htmldir)/configuration
@@ -78,7 +81,8 @@ paludisconfigurationhtml_DATA = \
configfiles.html \
specs.html \
sets.html \
- repositories.html
+ repositories.html \
+ erepository.html
index.html : header.html.part $(srcdir)/index.html.part footer.html.part
cat header.html.part $(srcdir)/index.html.part footer.html.part > $@
@@ -146,6 +150,12 @@ specpath.html.part : $(srcdir)/specpath.html.part.in $(srcdir)/paludisenvironmen
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/specpath.html.part.in > specpath.html.part
+erepository.html.part : $(srcdir)/erepository.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/erepository.html.part.in > erepository.html.part
+
environment.html.part : $(srcdir)/environment.html.part.in $(srcdir)/paludisenvironmentonly.html.part
sed \
-e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
@@ -236,6 +246,9 @@ use.html : header.html.part use.html.part footer.html.part
specpath.html : header.html.part specpath.html.part footer.html.part
cat header.html.part specpath.html.part footer.html.part > $@
+erepository.html : header.html.part erepository.html.part footer.html.part
+ cat header.html.part erepository.html.part footer.html.part > $@
+
syncers.html : header.html.part syncers.html.part footer.html.part
cat header.html.part syncers.html.part footer.html.part > $@
diff --git a/doc/configuration/erepository.html.part.in b/doc/configuration/erepository.html.part.in
new file mode 100644
index 0000000..e3d01eb
--- /dev/null
+++ b/doc/configuration/erepository.html.part.in
@@ -0,0 +1,84 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>ebuild Options</h1>
+
+###PALUDISENVIRONMENTONLY###
+
+<p>As well as the general keys supported for all repositories, the following keys have meaning for ebuild format
+repositories:</p>
+
+<dl>
+ <dt><code>master_repository</code></dt>
+ <dd>If set to the name of another ebuild-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.)</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.</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>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</code></dt>
+ <dd>The EAPI to use for profiles. 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.</dd>
+
+ <dt><code>sync_options</code></dt>
+ <dd>Any options to be passed to the syncer. Optional.</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>
+</dl>
+