Update documentation ENGINE-261
authorDamiano Boppart <damiano@pep-security.net>
Thu, 26 Oct 2017 17:02:40 +0200
branchENGINE-261
changeset 221437627cafddbb
parent 2213 04052cc0c922
child 2215 872b9aa07656
child 2719 69ef415bfbad
Update documentation
default.conf
     1.1 --- a/default.conf	Thu Oct 26 16:19:32 2017 +0200
     1.2 +++ b/default.conf	Thu Oct 26 17:02:40 2017 +0200
     1.3 @@ -3,14 +3,16 @@
     1.4  # This file may be used under the terms of the GNU General Public License version 3
     1.5  # see LICENSE.txt
     1.6  
     1.7 -# This file gives an overview over all the parameters that can be easily customized for a build.
     1.8 -# There are three ways in which you can customize your build:
     1.9 -# 1) Edit the variable assignments in this file
    1.10 -# 2) Create `local.conf` and fill it with variable assignments.
    1.11 -#    These `local.conf` takes precedence over the assignments below.
    1.12 -# 3) Set the environment variable `BUILD_CONFIG` to an absolute path.
    1.13 -#    The variable assignments found at the path indicated by `BUILD_CONFIG` take precedence over the assignments below and the assignments in `local.conf`.
    1.14 -# If nothing is changed according to these 3 methods, a default configuration for your platform will be used for the build.
    1.15 +# This file sets all the make variables that allow you to customize a build.
    1.16 +# There are 4 ways in which you can customize your build:
    1.17 +# 1) Edit the variable assignments in this file (this is a tracked file, so your repository will be dirty)
    1.18 +# 2) Edit the variable assignments in `Makefile.conf` (which is a tracked file, so your repository will be dirty)
    1.19 +# 3) Create `local.conf` and fill it with variable assignments.
    1.20 +# 4) Set the environment variable `BUILD_CONFIG` to an absolute path.
    1.21 +#    The variable assignments found in the make file at the path indicated by `BUILD_CONFIG` will be evaluated.
    1.22 +# Customization options are applied in the order given above. Later variable assignments take precedence over earlier ones.
    1.23 +# It is possible to use multiple variants simultaniously.
    1.24 +# If nothing is changed according to these 4 methods, a default configuration for your platform (specified below) will be used for the build.
    1.25  
    1.26  
    1.27  ######### Header #########