make.conf.example: document FFLAGS and FCFLAGS
[portage.git] / cnf / make.conf
index c410307d3605f51dfeba7fbb9afa061119581f6d..9e06d57755019b9ef557b9637b3b6ab002f6aae9 100644 (file)
@@ -1,6 +1,5 @@
-# Copyright 1999-2007 Gentoo Foundation
+# Copyright 1999-2011 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
-# $Id$
 # Contains local system settings for Portage system
 
 # Please review 'man make.conf' for more information.
 # If you set a CFLAGS above, then this line will set your default C++ flags to
 # the same settings.
 #CXXFLAGS="${CFLAGS}"
+#
+# If you set a CFLAGS above, then this line will set your default FORTRAN 77
+# flags to the same settings.
+#FFLAGS="${CFLAGS}"
+#
+# If you set a FFLAGS above, then this line will set your default FORTRAN
+# flags to the same settings for modern build systems
+#FCFLAGS="${FFLAGS}"
+
 
 # Advanced Masking
 # ================
 #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.
+#     emerges. After packages are built, it is safe to remove any and
+#     all files from this directory since they will be automatically
+#     fetched on demand for a given build. If you would like to
+#     selectively prune obsolete files from this directory, see
+#     eclean from the gentoolkit package. Note that locations under
+#     /usr/portage are not necessarily safe for data storage. See the
+#     PORTDIR documentation for more information.
 #DISTDIR=/usr/portage/distfiles
 #
 # PKGDIR is the location of binary packages that you can have created
 #
 # Portage uses wget by default. Here are some settings for some alternate
 # downloaders -- note that you need to merge these programs first before they
-# will be available.
+# will be available. The command should be written to place the fetched file
+# at \${DISTDIR}/\${FILE}.
 #
-# Default fetch command (5 tries, passive ftp for firewall compatibility)
-#FETCHCOMMAND="/usr/bin/wget -t 5 -T 60 --passive-ftp \${URI} -P \${DISTDIR}"
-#RESUMECOMMAND="/usr/bin/wget -c -t 5 -T 60 --passive-ftp \${URI} -P \${DISTDIR}"
+# Default fetch command (3 tries, passive ftp for firewall compatibility)
+#FETCHCOMMAND="/usr/bin/wget -t 3 -T 60 --passive-ftp -O \"\${DISTDIR}/\${FILE}\" \"\${URI}\""
+#RESUMECOMMAND="/usr/bin/wget -c -t 3 -T 60 --passive-ftp -O \"\${DISTDIR}/\${FILE}\" \"\${URI}\""
 #
 # Using wget, ratelimiting downloads
-#FETCHCOMMAND="/usr/bin/wget -t 5 -T 60 --passive-ftp --limit-rate=200k \${URI} -P \${DISTDIR}"
-#RESUMECOMMAND="/usr/bin/wget -c -t 5 -T 60 --passive-ftp --limit-rate=200k \${URI} -P \${DISTDIR}"
+#FETCHCOMMAND="/usr/bin/wget -t 3 -T 60 --passive-ftp --limit-rate=200k -O \"\${DISTDIR}/\${FILE}\" \"\${URI}\""
+#RESUMECOMMAND="/usr/bin/wget -c -t 3 -T 60 --passive-ftp --limit-rate=200k -O \"\${DISTDIR}/\${FILE}\" \"\${URI}\""
 #
 # Lukemftp (BSD ftp):
-#FETCHCOMMAND="/usr/bin/lukemftp -s -a -o \${DISTDIR}/\${FILE} \${URI}"
-#RESUMECOMMAND="/usr/bin/lukemftp -s -a -R -o \${DISTDIR}/\${FILE} \${URI}"
+#FETCHCOMMAND="/usr/bin/lukemftp -s -a -o \"\${DISTDIR}/\${FILE}\" \"\${URI}\""
+#RESUMECOMMAND="/usr/bin/lukemftp -s -a -R -o \"\${DISTDIR}/\${FILE}\" \"\${URI}\""
 #
 # Portage uses GENTOO_MIRRORS to specify mirrors to use for source retrieval.
 # The list is a space separated list which is read left to right. If you use
 # PORTAGE_RSYNC_RETRIES sets the number of times portage will attempt to retrieve
 #     a current portage tree before it exits with an error. This allows
 #     for a more successful retrieval without user intervention most times.
-#PORTAGE_RSYNC_RETRIES="3"
+#     If set to a negative number, then retry until all possible addresses are
+#     exhausted.
+#PORTAGE_RSYNC_RETRIES="-1"
 #
 # PORTAGE_RSYNC_EXTRA_OPTS can be used to feed additional options to the rsync
 #     command used by `emerge --sync`. This will not change the default options
 #     reduce it further. Default is unset.
 #PORTAGE_NICENESS=3
 #
+# PORTAGE_IONICE_COMMAND provides a command for portage to call in order to
+#     adjust the io priority of portage and it's subprocesses. Default is
+#     unset.
+#PORTAGE_IONICE_COMMAND="ionice -c 3 -p \${PID}"
+#
 # AUTOCLEAN enables portage to automatically clean out older or overlapping
 #     packages from the system after every successful merge. This is the
 #     same as running 'emerge -c' after every merge. Set with: "yes" or "no".
 #              packages.  Do not use it unless absolutely necessary!
 #AUTOCLEAN="yes"
 #
-# 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.
-#
-#  '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.
-#  'collision-protect'
-#                prevents packages from overwriting files that are owned by
-#                another package or by no package at all.
-#  '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).
-#  'test'        causes ebuilds to perform testing phases if they are capable
-#                of it. Some packages support this automatically via makefiles.
-#  'metadata-transfer'
-#                automatically perform a metadata transfer when `emerge --sync`
-#                is run.
-#  'noauto'      causes ebuild to perform only the action requested and 
-#                not any other required actions like clean or unpack -- 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
-#  'preserve-libs'
-#                keep libraries around that would normally removed by an upgrade, 
-#                but are still needed by other packages
-#  '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
-#                conflict with system security provisions (for example
-#                textrels, executable stacks).
-#  'userfetch'   when portage is run as root, drop privileges to
-#                portage:portage during the fetching of package sources.
-#  'userpriv'    allows portage to drop root privileges while it is compiling,
-#                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 ccache distcc distlocks"
+# FEATURES defines actions portage takes by default. This is an incremental
+# variable. See the make.conf(5) man page for a complete list of supported
+# values and their respective meanings.
+#FEATURES="ccache distcc installsources \
+# splitdebug test userpriv usersandbox"
 
 # CCACHE_SIZE and CCACHE_DIR are used to control the behavior of ccache, and
 #     and are only used if "ccache" is in FEATURES.
 # PORTAGE_ELOG_CLASSES: selects messages to be logged, possible values are:
 #                          info, warn, error, log, qa, *
 #                       Warning: commenting this will disable elog
-PORTAGE_ELOG_CLASSES="warn error log"
+PORTAGE_ELOG_CLASSES="log warn error"
 
 # PORTAGE_ELOG_SYSTEM: selects the module(s) to process the log messages. Modules
 #                      included in portage are (empty means logging is disabled):
@@ -373,6 +340,7 @@ PORTAGE_ELOG_CLASSES="warn error log"
 
 # PORTAGE_ELOG_MAILSUBJECT: template string to be used as subject for logmails. The following
 #                           variables are expanded:
+#                               ${ACTION} - merged, unmerged, or unknown
 #                               ${PACKAGE} - see description of PORTAGE_ELOG_COMMAND
 #                               ${HOST} - FQDN of the host portage is running on
 #PORTAGE_ELOG_MAILSUBJECT="[portage] ebuild log for \${PACKAGE} on \${HOST}"