xbps-src.conf: enable -mtune=generic by default to C{,XX}FLAGS, misc comments.

xbps-src/etc/xbps-src.conf.in

@@ -1,26 +1,28 @@
+# --*-- shell --*--
+# Configuration file for the XBPS source build system.
 #
-# Configuration file for xbps-src.
+# To disable an option comment it out, don't set it to another value i.e:
+#    FOO=no 	-> wrong
+#    #FOO=yes	-> correct
 
+# [REQUIRED]
 # Directory where the xbps-src GIT repository is stored. This is
 # required to be mounted in the chroot. You shouldn't need to modify this
-# one unless your xbps-packages repo has been moved to another path.
+# one unless your xbps-packages git repo has been moved to another path.
-#
 XBPS_DISTRIBUTIONDIR=@@XBPS_DISTRIBDIR@@
 
-#
+# [REQUIRED]
-# Chroot master directory.
+# Chroot master directory. This is where the packages are built and installed.
-#
 XBPS_MASTERDIR=$XBPS_DISTRIBUTIONDIR/masterdir
 
-#
+# [OPTIONAL]
-# Host directory to be bind mounted into the chroot (masterdir) containing
+# Host directory to be (bind) mounted into the chroot (masterdir) containing
 # directories for downloaded cached packages from xbps-bin(8), packages
-# created by xbps-src, source distribution tarballs downloaded required
+# created by xbps-src, downloaded source distribution tarballs, etc.
-# to build packages from source, etc.
 #
 # Basically your directory will contain this structure:
 #
-# /yourdir
+# 	/dir
 # 	|_ /binpkgs
 # 	|_ /repocache
 # 	|_ /sources
@@ -28,60 +30,60 @@ XBPS_MASTERDIR=$XBPS_DISTRIBUTIONDIR/masterdir
 # When created, those names are constants, so you cannot change them, even
 # they are case sensitive.
 #
-# NOTE: You must create your toplevel /yourdir yourself
+# NOTE: You must create your toplevel /dir yourself
 #
 #XBPS_HOSTDIR=/path/to/your/host/directory
 
-#
+# [OPTIONAL]
 # Compilation flags for C and C++.
-#
+XBPS_CFLAGS="-O2 -pipe -mtune=generic"
-XBPS_CFLAGS="-O2 -pipe"
 XBPS_CXXFLAGS="$XBPS_CFLAGS"
 
-#
+# [OPTIONAL]
-# Enable or disable ccache to build packages from source.
+# Enable or disable ccache when building packages.
-#
 #XBPS_CCACHE=yes
 
-#
+# [OPTIONAL]
 # Linker flags passed to the compiler. By default we use --as-needed to
 # avoid linking extra libraries into binaries. See the following link
-# for info:
+# for info: http://www.gentoo.org/proj/en/qa/asneeded.xml
-#
-# http://www.gentoo.org/proj/en/qa/asneeded.xml
-#
 XBPS_LDFLAGS="-Wl,--as-needed"
 
-#
+# [OPTIONAL]
-# Number of jobs when running make(1)-alike commands.
+# Number of parallel jobs to execute when building packages that
-#
+# use make(1) or alike commands.
 #XBPS_MAKEJOBS=4
 
-#
+# [REQUIRED]
 # Compression program used to build the binary packages.
 # Possible value: gzip, bzip2 or xz. Default xz.
-#
 XBPS_COMPRESS_CMD=xz
 
-#
+# [OPTIONAL]
 # Compression level used in XBPS_COMPRESS_CMD to build the
 # binary packages. Possible values: 1-9. If unset, default value
 # by the command will be used.
-#
 XBPS_COMPRESS_LEVEL=9
 
+# [OPTIONAL]
+# Install required package dependencies from binary packages, through
+# binary package repositories as specified in the XBPS repositories.plist
+# configuration file.
 #
-# Install required build time dependencies from binary packages,
+# Only dependencies for non bootstrap packages will be installed.
-# repositories registered in <masterdir>/usr/local/etc/xbps-conf.plist
+# Make sure that you modify the repositories.plist file from:
-# will be used.
+#
+# XBPS >= 0.10.0:
+# 	<masterdir>/usr/local/etc/xbps/repositories.plist.
+# XBPS < 0.10.0:
+# 	<masterdir>/usr/local/etc/xbps-conf.plist
 #
 #XBPS_PREFER_BINPKG_DEPS=yes
 
-#
+# [OPTIONAL]
 # Build packages with your unprivileged user in the chroot thanks
 # to POSIX.1e Capabilities as explained in capabilities(7) on GNU/Linux.
 #
 # fakeroot is only used for the installation stage via the helper
 # script doinst-helper.
-#
 XBPS_USE_CAPABILITIES=yes