From: Mike Frysinger <vapier@gentoo.org>
Date: Sun, 5 Jan 2014 19:06:01 +0000 (-0500)
Subject: portage(5): layout.conf: add a proper format/attributes section
X-Git-Tag: v2.2.8~7
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;ds=sidebyside;h=77c4a5b31fb5b42e1e4969bf1747cc5e416eca2f;p=portage.git

portage(5): layout.conf: add a proper format/attributes section

URL: https://bugs.gentoo.org/395359
---

diff --git a/man/portage.5 b/man/portage.5
index 9a191d093..8f7f6e4a2 100644
--- a/man/portage.5
+++ b/man/portage.5
@@ -980,26 +980,82 @@ Also see \fB/var/lib/portage/world_sets\fR and the \fBemerge\fR(1)
 .RS
 .TP
 .BR layout.conf
-Specifies information about the repository layout. A
-"masters" attribute is supported, which is used to specify names of
-repositories which satisfy dependencies on eclasses and/or ebuilds. Each
+Specifies information about the repository layout.
+\fISite-specific\fR overrides to \fBlayout.conf\fR settings may be specified in
+\fB/etc/portage/repos.conf\fR.
+Settings in \fBrepos.conf\fR take precedence over settings in
+\fBlayout.conf\fR, except tools such as \fBrepoman\fR(1) and \fBegencache\fR(1)
+ignore "aliases", "eclass-overrides" and "masters" attributes set in
+\fBrepos.conf\fR since their operations are inherently \fBnot\fR
+\fIsite\-specific\fR.
+
+.I Format:
+.nf
+\- comments begin with # (no inline comments)
+\- attributes are specified in "${attribute} = ${value}" format
+.fi
+
+.I Supported attributes.
+.RS
+.RS
+.TP
+.BR aliases
+Behaves like an "aliases" attribute in \fBrepos.conf\fR.
+.TP
+.BR eapis\-banned
+List of EAPIs which are not allowed in this repo.
+.TP
+.BR eapis\-deprecated
+List of EAPIs which are allowed but generate warnings when used.
+.TP
+.BR masters
+Names of repositories which satisfy dependencies on eclasses and/or ebuilds. Each
 repository name should correspond the value of a \fBrepo_name\fR entry
 from one of the repositories that is configured via the \fBPORTDIR\fR or
 \fBPORTDIR_OVERLAY\fR variables (see \fBmake.conf\fR(5)). Repositories listed
 toward the right of the \fBmasters\fR list take precedence over those listed
-toward the left of the list. An "aliases" attribute is also supported, which
-behaves like an "aliases" attribute in \fBrepos.conf\fR. \fISite-specific\fR
-overrides to \fBlayout.conf\fR settings may be specified in
-\fB/etc/portage/repos.conf\fR. Settings in \fBrepos.conf\fR take
-precedence over settings in \fBlayout.conf\fR, except tools such as
-\fBrepoman\fR(1) and \fBegencache\fR(1) ignore "aliases", "eclass-overrides"
-and "masters" attributes set in \fBrepos.conf\fR since their operations are
-inherently \fBnot\fR \fIsite\-specific\fR.
+toward the left of the list.
+.TP
+.BR repo\-name " = <value of profiles/repo_name>"
+The name of this repository (overrides profiles/repo_name if it exists).
+.TP
+.BR sign\-commits " = [true|" false "]"
+Boolean value whether we should sign commits in this repo.
+.TP
+.BR sign\-manifests " = [" true "|false]"
+Boolean value whether we should sign Manifest files in this repo.
+.TP
+.BR thin\-manifests " = [true|" false "]"
+Boolean value whether Manifest files contain only DIST entries.
+.TP
+.BR use\-manifests " = [" strict "|true|false]"
+How Manifest files get used.  Possible values are "strict" (require an entry
+for every file), "true" (if an entry exists for a file, enforce it), or "false"
+(don't check Manifest files at all).
+.TP
+.BR manifest\-hashes
+List of hashes to generate/check in Manifest files.  Valid hashes depend on the
+current version of portage; see the portage.const.MANIFEST2_HASH_FUNCTIONS
+constant for the current list.
+.TP
+.BR update\-changelog " = [true|" false "]"
+The default setting for repoman's --echangelog option.
+.TP
+.BR cache\-formats " = [pms] [md5-dict]"
+The cache formats supported in the metadata tree.  There is the old "pms" format
+and the newer/faster "md5-dict" format.  Default is to detect dirs.
+.TP
+.BR profile\-formats " = [portage-1|" portage-1-compat "|portage-2]"
+Control functionality available to profiles in this repo such as which files
+may be dirs, or the syntax available in parent files.  Use "portage-2" if you're
+unsure.
+.RE
+.RE
 
+.RS
 .I Example:
 .nf
-# Specify the repository name (if there is a different setting in
-# profiles/repo_name, then this layout.conf setting will take precedence)
+# Specify the repository name (overriding profils/repo_name).
 repo\-name = foo-overlay
 
 # eclasses provided by java-overlay take precedence over identically named
@@ -1051,6 +1107,7 @@ cache\-formats = md5-dict pms
 profile\-formats = portage-2
 .fi
 .RE
+.RE
 .TP
 .BR /usr/portage/profiles/
 Global Gentoo settings that are controlled by the developers.  To override