Update the PORT_LOGDIR docs for bug #82378. Thanks to Arfrever FTA for reporting. (branches/2.1.2 r6811)

svn path=/main/branches/2.1.2.9/; revision=7460

2 files changed, 37 insertions, 32 deletions

diff --git a/cnf/make.conf b/cnf/make.conf
index d4094786..15d54da0 100644
--- a/cnf/make.conf
+++ b/cnf/make.conf
@@ -1,4 +1,4 @@
-# Copyright 1999-2007 Gentoo Foundation
+# Copyright 1999-2006 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 # $Id$
 # Contains local system settings for Portage system
@@ -78,28 +78,18 @@
 # PORTDIR is the location of the portage tree. This is the repository
 #     for all profile information as well as all ebuilds. If you change
 #     this, you must update your /etc/make.profile symlink accordingly.
-#     ***Warning***
-#     Data stored inside PORTDIR is in peril of being overwritten or deleted by
-#     the emerge --sync command. The default value of PORTAGE_RSYNC_OPTS
-#     will protect the default locations of DISTDIR and PKGDIR, but users are
-#     warned that any other locations inside PORTDIR are not necessarily safe
-#     for data storage.
 #PORTDIR=/usr/portage
 #
 # DISTDIR is where all of the source code tarballs will be placed for
 #     emerges. The source code is maintained here unless you delete
 #     it. The entire repository of tarballs for Gentoo is 9G. This is
 #     considerably more than any user will ever download. 2-3G is
-#     a large DISTDIR. Note that locations under /usr/portage are not
-#     necessarily safe for data storage. See the PORTDIR documentation
-#     for more information.
+#     a large DISTDIR.
 #DISTDIR=/usr/portage/distfiles
 #
 # PKGDIR is the location of binary packages that you can have created
 #     with '--buildpkg' or '-b' while emerging a package. This can get
-#     up to several hundred megs, or even a few gigs. Note that
-#     locations under /usr/portage are not necessarily safe for data
-#     storage. See the PORTDIR documentation for more information.
+#     up to several hundred megs, or even a few gigs.
 #PKGDIR=/usr/portage/packages
 #
 # PORT_LOGDIR is the location where portage will store all the logs it
@@ -247,26 +237,44 @@
 #
 # FEATURES are settings that affect the functionality of portage. Most of
 #     these settings are for developer use, but some are available to non-
-#     developers as well.
+#     developers as well. 
 #
+#  'assume-digests'
+#                when committing work to cvs with repoman(1), assume that all
+#                existing SRC_URI digests are correct.  This feature also
+#                affects digest generation via ebuild(1) and emerge(1) (emerge
+#                generates digests only when the 'digest' feature is enabled).
 #  'buildpkg'    causes binary packages to be created of all packages that 
 #                are being merged.
-#  'buildsyspkg' only build binary packages for system packages.
 #  'ccache'      enable support for the dev-util/ccache package, which can
 #                noticably decrease the time needed to remerge previously built
 #                packages.
+#  'confcache'   enable confcache support; speeds up autotool based configure
+#                calls
 #  'collision-protect'
 #                prevents packages from overwriting files that are owned by
 #                another package or by no package at all.
+#  'cvs'         causes portage to enable all cvs features (commits, adds),
+#                and to apply all USE flags in SRC_URI for digests -- for
+#                developers only.
+#  'digest'      autogenerate digests for packages when running the emerge(1)
+#                command.  If the 'assume-digests' feature is also enabled then
+#                existing SRC_URI digests will be reused whenever they are
+#                available.
 #  'distcc'      enables distcc support via CC.
 #  'distlocks'   enables distfiles locking using fcntl or hardlinks. This
 #                is enabled by default. Tools exist to help clean the locks
 #                after crashes: /usr/lib/portage/bin/clean_locks.
-#  'installsources'
-#                Install source code into /usr/src/debug/${CATEGORY}/${PF}
-#                (also see 'splitdebug'). This feature works only if debugedit
-#                is installed and CFLAGS is set to include debug information
-#                (such as with the -ggdb flag).
+#  'fixpackages' allows portage to fix binary packages that are stored in
+#                PKGDIR. This can consume a lot of time. 'fixpackages' is
+#                also a script that can be run at any given time to force
+#                the same actions.
+#  'gpg'         enables basic verification of Manifest files using gpg.
+#                This features is UNDER DEVELOPMENT and reacts to features
+#                of strict and severe. Heavy use of gpg sigs is coming.
+#  'keeptemp'    prevents the clean phase from deleting the temp files ($T) 
+#                from a merge.
+#  'keepwork'    prevents the clean phase from deleting the WORKDIR.
 #  'test'        causes ebuilds to perform testing phases if they are capable
 #                of it. Some packages support this automatically via makefiles.
 #  'metadata-transfer'
@@ -275,15 +283,13 @@
 #  'noauto'      causes ebuild to perform only the action requested and 
 #                not any other required actions like clean or unpack -- for
 #                debugging purposes only.
+#  'noclean'     prevents portage from removing the source and temporary files 
+#                after a merge -- for debugging purposes only. 
 #  'nostrip'     prevents the stripping of binaries.
 #  'notitles'    disables xterm titlebar updates (which contain status info). 
 #  'parallel-fetch'
 #                do fetching in parallel to compilation
 #  'sandbox'     enables sandboxing when running emerge and ebuild.
-#  'splitdebug'  Prior to stripping ELF etdyn and etexec files, the debugging
-#                info is stored for later use by various debuggers.  This
-#                feature is disabled by 'nostrip'.  For installation of source
-#                code, see 'installsources'.
 #  'strict'      causes portage to react strongly to conditions that are
 #                potentially dangerous, like missing/incorrect Manifest files.
 #  'stricter'    causes portage to react strongly to conditions that may
@@ -295,7 +301,7 @@
 #                as a security measure.  As a side effect this can remove 
 #                sandbox access violations for users. 
 #  'usersandbox' enables sandboxing while portage is running under userpriv.
-#FEATURES="sandbox buildpkg ccache distcc userpriv usersandbox notitles noauto"
+#FEATURES="sandbox buildpkg ccache distcc userpriv usersandbox notitles noclean noauto cvs keeptemp keepwork"
 #FEATURES="sandbox ccache distcc distlocks"
 
 # CCACHE_SIZE and CCACHE_DIR are used to control the behavior of ccache, and
@@ -321,13 +327,12 @@
 
 # logging related variables:
 # PORTAGE_ELOG_CLASSES: selects messages to be logged, possible values are:
-#                          info, warn, error, log, qa, *
+#                          info, warn, error, log, qa
 #                       Warning: commenting this will disable elog
 PORTAGE_ELOG_CLASSES="warn error log"
 
 # PORTAGE_ELOG_SYSTEM: selects the module(s) to process the log messages. Modules
 #                      included in portage are (empty means logging is disabled):
-#                          echo (display messages again when emerge exits)
 #                          save (saves one log per package in $PORT_LOGDIR/elog, 
 #                                /var/log/portage/elog if $PORT_LOGDIR is unset)
 #                          custom (passes all messages to $PORTAGE_ELOG_COMMAND)
@@ -341,10 +346,6 @@ PORTAGE_ELOG_CLASSES="warn error log"
 #                          mail_summary (like "mail" but sends all messages in
 #                                        a single mail when emerge exits)
 #                      To use elog you should enable at least one module
-#                      The module name may be followed by a colon and a comma
-#                      separated list of loglevels to override PORTAGE_ELOG_CLASSES
-#                      for this module (e.g.
-#                        PORTAGE_ELOG_SYSTEM="mail:warn,error syslog:* save")
 #PORTAGE_ELOG_SYSTEM="save mail"
 
 # PORTAGE_ELOG_COMMAND: only used with the "custom" logging module. Specifies a command
diff --git a/man/make.conf.5 b/man/make.conf.5
index 06fd1c48..5c211f92 100644
--- a/man/make.conf.5
+++ b/man/make.conf.5
@@ -325,7 +325,11 @@ Defaults to /usr/portage/packages.
 .TP
 .B PORT_LOGDIR
 This variable defines the directory in which per\-ebuild logs are kept.
-Logs are created only when this is set and writable.
+Logs are created only when this is set. They are stored as
+${CATEGORY}:${PF}:YYYYMMDD\-HHMMSS.log in the directory specified. If the
+direcory does not exist, it will be created automatically and group permissions
+will be applied to it.  If the directory already exists, portage will not
+modify it's permissions.
 .TP
 \fBPORTAGE_BINHOST\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp"\fR
 This is the host from which portage will grab prebuilt\-binary packages.