Wrap long comments at sentence boundaries, instead of arbitrarily.
authorDamiano Boppart <damiano@pep-security.net>
Tue, 19 Sep 2017 14:39:41 +0200
changeset 2070d834a86b51e9
parent 2069 21c3f4a8174f
child 2072 ecc35092791d
child 2076 2aadece6fcf4
Wrap long comments at sentence boundaries, instead of arbitrarily.
Makefile.conf
build-config/common.conf
     1.1 --- a/Makefile.conf	Tue Sep 19 13:50:08 2017 +0200
     1.2 +++ b/Makefile.conf	Tue Sep 19 14:39:41 2017 +0200
     1.3 @@ -3,22 +3,17 @@
     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 assembles all the make variables that a maintainer or dev may
     1.8 -# want to taylor to his or her needs on a given platform.
     1.9 +# This file assembles all the make variables that a maintainer or dev may want to adapt for a distribution.
    1.10  
    1.11 -# To use custom build configuration variables, put them in a new file with
    1.12 -# the path `build-config/<name>.conf`.
    1.13 -# Execute `export PLATFORM_OVERRIDE=<name>` before running make.  If this
    1.14 -# environment variable is not set, make will load a default configuration
    1.15 -# for your platform.
    1.16 +# To use custom build configuration variables, put them in a new file with the path `build-config/<name>.conf`.
    1.17 +# Execute `export PLATFORM_OVERRIDE=<name>` before running make.
    1.18 +# If this environment variable is not set, make will load a default configuration for your platform.
    1.19  
    1.20  BUILD_CONFIG:=$(dir $(lastword $(MAKEFILE_LIST)))build-config
    1.21  
    1.22  include $(BUILD_CONFIG)/common.conf
    1.23 -
    1.24 -# cross-compiling is currently not supported, but maybe you can hack
    1.25 -# something with `PLATFORM_OVERRIDE`
    1.26 -
    1.27 +# Cross-compiling is currently not supported.
    1.28 +# Maybe you can hack something with `PLATFORM_OVERRIDE`
    1.29  ifeq ($(BUILD_ON),$(BUILD_FOR))
    1.30      include $(BUILD_CONFIG)/$(BUILD_ON).conf
    1.31  else
     2.1 --- a/build-config/common.conf	Tue Sep 19 13:50:08 2017 +0200
     2.2 +++ b/build-config/common.conf	Tue Sep 19 14:39:41 2017 +0200
     2.3 @@ -3,42 +3,31 @@
     2.4  # This file may be used under the terms of the GNU General Public License version 3
     2.5  # see LICENSE.txt
     2.6  
     2.7 -# General remark: to use (only) system libraries, set all the *_INC and
     2.8 -# *_LIB variables to the empty string.
     2.9 -# All the *_INC and *_LIB variables are command line flags, not paths. 
    2.10 -# Thus, all *_INC variables' values must start with "-I", and all *_LIB
    2.11 -# variables' values must start with "-L".
    2.12 +# General remark: to use (only) system libraries, set all the *_INC and *_LIB variables to the empty string.
    2.13 +# All the *_INC and *_LIB variables are command line flags, not paths.
    2.14 +# Thus, all *_INC variables' values must start with "-I", and all *_LIB variables' values must start with "-L".
    2.15  
    2.16  ######### General #########
    2.17 -
    2.18  BUILD_ON:=$(shell uname)
    2.19 -
    2.20  # This variable specifies the platform that the engine should be cross-compiled for.
    2.21  BUILD_FOR=$(BUILD_ON)
    2.22 -
    2.23  # Installation path prefix for libraries and binaries, except for system.db
    2.24  PREFIX=$(HOME)
    2.25 -
    2.26  # Installation path for system.db
    2.27  SYSTEM_DB=/usr/local/share/pEp/system.db
    2.28 -
    2.29  # Filename of the pEpEngine library
    2.30  #TARGET This option is platform-specific
    2.31 -
    2.32 -# If not empty, create a debug build.  This variable is ineffective in your
    2.33 -# PLATFORM_OVERRIDE.conf file.
    2.34 +# If not empty, create a debug build.
    2.35 +# This variable is ineffective in your PLATFORM_OVERRIDE.conf file.
    2.36  DEBUG=
    2.37 -
    2.38 -# If not empty, print compiler warnings.  This variable is ineffective in
    2.39 -# your PLATFORM_OVERRIDE.conf file.
    2.40 +# If not empty, print compiler warnings.
    2.41 +# This variable is ineffective in your PLATFORM_OVERRIDE.conf file.
    2.42  WARN=placeholder
    2.43  
    2.44  ######### C #########
    2.45  #CC This option is platform-specific
    2.46  CPPFLAGS=
    2.47 -
    2.48  #CFLAGS This option is platform-specific
    2.49 -
    2.50  # Additional CFLAGS used for compiling ASN1C-generated code
    2.51  #CFLAGS_GENERATED This option is platform-specific
    2.52  
    2.53 @@ -48,9 +37,8 @@
    2.54  
    2.55  ######### C and C++ #########
    2.56  TARGET_ARCH=
    2.57 -
    2.58 -# The following two variables will be appended to.  You can thus not set
    2.59 -# them to a fixed value here.
    2.60 +# The following two variables will be appended to.
    2.61 +# You can thus not set them to a fixed value here.
    2.62  #LDFLAGS= This option is platform-specific
    2.63  LDLIBS=
    2.64  
    2.65 @@ -62,7 +50,6 @@
    2.66  ######### asn1c #########
    2.67  # asn1c binary
    2.68  ASN1C=asn1c
    2.69 -
    2.70  # asn1c include search flag
    2.71  ASN1C_INC=
    2.72  #ASN1C_INC=-I$(HOME)/include
    2.73 @@ -70,36 +57,28 @@
    2.74  ######### libetpan #########
    2.75  # libetpan library search flag
    2.76  ETPAN_LIB=-L$(PREFIX)/lib
    2.77 -
    2.78  # libetpan include search flag
    2.79  ETPAN_INC=-I$(PREFIX)/include
    2.80  
    2.81  ######### sqlite3 #########
    2.82 -# If empty (or undefined), compile sqlite3 from the sources shipped with the
    2.83 -# pEp distribution.  Otherwise, use an sqlite3 implementation found in the
    2.84 -# OS's include/library paths.
    2.85 +# If empty (or undefined), compile sqlite3 from the sources shipped with the pEp distribution.
    2.86 +# Otherwise, use an sqlite3 implementation found in the OS's include/library paths.
    2.87  SQLITE3_FROM_OS=placeholder
    2.88  
    2.89  ######### OpenPGP #########
    2.90  # Path of GPG binary
    2.91  GPG_CMD:=$(shell gpgconf --list-components | awk -F: '/^gpg:/ { print $$3; exit 0; }')
    2.92 -
    2.93  # Selects OpenPGP implementation. must be either `GPG` or `NETPGP`
    2.94  OPENPGP=GPG
    2.95 -
    2.96  # Path of libGPGME binary
    2.97  #LIBGPGME This option is platform-specific
    2.98 -
    2.99  # libGPGME library search flag
   2.100  #GPGME_LIB= This option is platform-specific
   2.101 -
   2.102  # libGPGME include search flag
   2.103  #GPGME_INC= This option is platform-specific
   2.104 -
   2.105  # NETPGP library search flag
   2.106  NETPGP_LIB=
   2.107  #NETPGP_LIB=-L$(PREFIX)/lib
   2.108 -
   2.109  # libGPGME include search flag
   2.110  NETPGP_INC=
   2.111  #NETPGP_INC=-I$(PREFIX)/include
   2.112 @@ -113,6 +92,6 @@
   2.113  EXTRA_MACROS=
   2.114  
   2.115  ######### Misc #########
   2.116 -# FIXME Maybe include these variables here.  Check how they are used
   2.117 -# throughout the project before setting them here
   2.118 +# FIXME Maybe include these variables here.
   2.119 +# Check how they are used throughout the project before setting them here
   2.120  #LLDB_BIN