[gentoo-portage-dev] [PATCH] Document layout.conf more (bug 395359)

[gentoo-portage-dev] [PATCH] Document layout.conf more (bug 395359)

[SebastianLuther]

From: Sebastian Luther <SebastianLuther@gmx.de>

---
 man/portage.5 | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/man/portage.5 b/man/portage.5
index 9a191d0..0eb3c54 100644
--- a/man/portage.5
+++ b/man/portage.5
@@ -1002,42 +1002,61 @@ inherently \fBnot\fR \fIsite\-specific\fR.
 # profiles/repo_name, then this layout.conf setting will take precedence)
 repo\-name = foo-overlay
 
+# eclasses provided by the current repository take precedence over identically
+# named eclasses provided by java-overlay
 # eclasses provided by java-overlay take precedence over identically named
 # eclasses that are provided by gentoo
+# value: space delimited list of repository names
+# default: the 'main-repo' from repos.conf
+# use 'masters =' to set no master
 masters = gentoo java-overlay
 
 # indicate that this repo can be used as a substitute for foo-overlay
+# value: space delimited list of repository names (default: empty)
 aliases = foo-overlay
 
 # indicate that ebuilds with the specified EAPIs are banned
+# value: space delimited list of EAPIs (default: empty)
 eapis\-banned = 0 1
 
 # indicate that ebuilds with the specified EAPIs are deprecated
+# value: space delimited list of EAPIs (default: empty)
 eapis\-deprecated = 2 3
 
 # sign commits in this repo, which requires Git >=1.7.9, and
 # key configured by `git config user.signingkey key_id`
+# value: true or false (default: false)
 sign\-commits = true
 
 # do not sign Manifest files in this repo
+# value: true or false (default: true)
 sign\-manifests = false
 
 # Manifest files only contain DIST entries
+# value: true or false (default: false)
 thin\-manifests = true
 
 # indicate that this repo requires manifests for each package, and is
 # considered a failure if a manifest file is missing/incorrect
+# value: strict or false (default: strict)
 use\-manifests = strict
 
 # customize the set of hashes generated for Manifest entries
+# value: space separated list of hash functions
+# supported hash functions: SHA256 SHA512 WHIRLPOOL
+# default: SHA256 SHA512 WHIRLPOOL
 manifest\-hashes = SHA256 SHA512 WHIRLPOOL
 
 # indicate that this repo enables repoman's --echangelog=y option automatically
+# value: true or false (default: false)
 update\-changelog = true
 
 # indicate that this repo contains both md5-dict and pms cache formats,
 # which may be generated by egencache(1)
-cache\-formats = md5-dict pms
+# value: space separated list of cache formats
+# supported cache formats: md5-dict pms
+# default: md5-dict, if avaiable, pms otherwise
+cache\-formats = md5-dict
 
 # indicate that this repo contains profiles that may use directories for
 # package.mask, package.provided, package.use, package.use.force,
@@ -1048,6 +1067,9 @@ cache\-formats = md5-dict pms
 # profile parent files can be used to express paths relative to the root
 # 'profiles' directory of a repository (when the repo name is omitted before
 # the colon, it refers to the current repository the parent file is inside)
+# value: space separated list of profile formats
+# supported profile formats: pms portage-1 portage-2
+# default: portage-1, but warns for incompatibilities with pms
 profile\-formats = portage-2
 .fi
 .RE
-- 
1.8.3.2

Re: [gentoo-portage-dev] [PATCH] Document layout.conf more (bug 395359)

[Mike Frysinger]

[-- Attachment #1: Type: Text/Plain, Size: 166 bytes --]

extending the example isn't the way to go.  see the commit i pushed.  if 
you've got details that i missed, then rebase on top of that and send an 
update.
-mike

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 836 bytes --]

Re: [gentoo-portage-dev] [PATCH] Document layout.conf more (bug 395359)

[Sebastian Luther]

Am 05.01.2014 20:31, schrieb Mike Frysinger:
> extending the example isn't the way to go.  see the commit i
> pushed.  if you've got details that i missed, then rebase on top of
> that and send an update. -mike
> 
Yes, your's looks better.

One thing about the 'profile-formats' key.

portage-1-compat is not a valid value (see _valid_profile_formats
variable), but pms is.

From the use in other places it seems that portage-1-compat is like
portage-1, but warns for incompatibilities with pms.

Sebastian

Re: [gentoo-portage-dev] [PATCH] Document layout.conf more (bug 395359)

[Mike Frysinger]

[-- Attachment #1: Type: Text/Plain, Size: 486 bytes --]

On Sunday 05 January 2014 16:44:31 Sebastian Luther wrote:
> One thing about the 'profile-formats' key.
> 
> portage-1-compat is not a valid value (see _valid_profile_formats
> variable), but pms is.
> 
> From the use in other places it seems that portage-1-compat is like
> portage-1, but warns for incompatibilities with pms.

portage-1-compat is used internally by portage, but you're right that it's not 
allowed to be set directly.  i'll tweak the section a bit.
-mike

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 836 bytes --]