split overlong lines in comments, so it can be read without horizontal scrolling
authorRoker <roker@pep-project.org>
Tue, 19 Sep 2017 13:50:08 +0200
changeset 206921c3f4a8174f
parent 2068 997cd3a4148e
child 2070 d834a86b51e9
child 2071 7bdd10417b1c
split overlong lines in comments, so it can be read without horizontal scrolling
build-config/common.conf
     1.1 --- a/build-config/common.conf	Tue Sep 19 13:32:04 2017 +0200
     1.2 +++ b/build-config/common.conf	Tue Sep 19 13:50:08 2017 +0200
     1.3 @@ -3,28 +3,42 @@
     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 -# General remark: to use (only) system libraries, set all the *_INC and *_LIB variables to the empty string.
     1.8 -# All the *_INC and *_LIB variables are command line flags, not paths. Thus, all *_INC variables' values must start with "-I", and all *_LIB variables' values must start with "-L".
     1.9 +# General remark: to use (only) system libraries, set all the *_INC and
    1.10 +# *_LIB variables to the empty string.
    1.11 +# All the *_INC and *_LIB variables are command line flags, not paths. 
    1.12 +# Thus, all *_INC variables' values must start with "-I", and all *_LIB
    1.13 +# variables' values must start with "-L".
    1.14  
    1.15  ######### General #########
    1.16 +
    1.17  BUILD_ON:=$(shell uname)
    1.18 +
    1.19  # This variable specifies the platform that the engine should be cross-compiled for.
    1.20  BUILD_FOR=$(BUILD_ON)
    1.21 +
    1.22  # Installation path prefix for libraries and binaries, except for system.db
    1.23  PREFIX=$(HOME)
    1.24 +
    1.25  # Installation path for system.db
    1.26  SYSTEM_DB=/usr/local/share/pEp/system.db
    1.27 +
    1.28  # Filename of the pEpEngine library
    1.29  #TARGET This option is platform-specific
    1.30 -# If not empty, create a debug build. This variable is ineffective in your PLATFORM_OVERRIDE.conf file.
    1.31 +
    1.32 +# If not empty, create a debug build.  This variable is ineffective in your
    1.33 +# PLATFORM_OVERRIDE.conf file.
    1.34  DEBUG=
    1.35 -# If not empty, print compiler warnings. This variable is ineffective in your PLATFORM_OVERRIDE.conf file.
    1.36 +
    1.37 +# If not empty, print compiler warnings.  This variable is ineffective in
    1.38 +# your PLATFORM_OVERRIDE.conf file.
    1.39  WARN=placeholder
    1.40  
    1.41  ######### C #########
    1.42  #CC This option is platform-specific
    1.43  CPPFLAGS=
    1.44 +
    1.45  #CFLAGS This option is platform-specific
    1.46 +
    1.47  # Additional CFLAGS used for compiling ASN1C-generated code
    1.48  #CFLAGS_GENERATED This option is platform-specific
    1.49  
    1.50 @@ -34,7 +48,9 @@
    1.51  
    1.52  ######### C and C++ #########
    1.53  TARGET_ARCH=
    1.54 -# The following two variables will be appended to. You can thus not set them to a fixed value here.
    1.55 +
    1.56 +# The following two variables will be appended to.  You can thus not set
    1.57 +# them to a fixed value here.
    1.58  #LDFLAGS= This option is platform-specific
    1.59  LDLIBS=
    1.60  
    1.61 @@ -46,6 +62,7 @@
    1.62  ######### asn1c #########
    1.63  # asn1c binary
    1.64  ASN1C=asn1c
    1.65 +
    1.66  # asn1c include search flag
    1.67  ASN1C_INC=
    1.68  #ASN1C_INC=-I$(HOME)/include
    1.69 @@ -53,27 +70,36 @@
    1.70  ######### libetpan #########
    1.71  # libetpan library search flag
    1.72  ETPAN_LIB=-L$(PREFIX)/lib
    1.73 +
    1.74  # libetpan include search flag
    1.75  ETPAN_INC=-I$(PREFIX)/include
    1.76  
    1.77  ######### sqlite3 #########
    1.78 -# If empty (or undefined), compile sqlite3 from the sources shipped with the pEp distribution. Otherwise, use an sqlite3 implementation found in the OS's include/library paths.
    1.79 +# If empty (or undefined), compile sqlite3 from the sources shipped with the
    1.80 +# pEp distribution.  Otherwise, use an sqlite3 implementation found in the
    1.81 +# OS's include/library paths.
    1.82  SQLITE3_FROM_OS=placeholder
    1.83  
    1.84  ######### OpenPGP #########
    1.85  # Path of GPG binary
    1.86  GPG_CMD:=$(shell gpgconf --list-components | awk -F: '/^gpg:/ { print $$3; exit 0; }')
    1.87 +
    1.88  # Selects OpenPGP implementation. must be either `GPG` or `NETPGP`
    1.89  OPENPGP=GPG
    1.90 +
    1.91  # Path of libGPGME binary
    1.92  #LIBGPGME This option is platform-specific
    1.93 +
    1.94  # libGPGME library search flag
    1.95  #GPGME_LIB= This option is platform-specific
    1.96 +
    1.97  # libGPGME include search flag
    1.98  #GPGME_INC= This option is platform-specific
    1.99 +
   1.100  # NETPGP library search flag
   1.101  NETPGP_LIB=
   1.102  #NETPGP_LIB=-L$(PREFIX)/lib
   1.103 +
   1.104  # libGPGME include search flag
   1.105  NETPGP_INC=
   1.106  #NETPGP_INC=-I$(PREFIX)/include
   1.107 @@ -87,5 +113,6 @@
   1.108  EXTRA_MACROS=
   1.109  
   1.110  ######### Misc #########
   1.111 -# FIXME Maybe include these variables here. Check how they are used throughout the project before setting them here
   1.112 +# FIXME Maybe include these variables here.  Check how they are used
   1.113 +# throughout the project before setting them here
   1.114  #LLDB_BIN