X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senfscons%2FMainpage.dox;h=7769355e7246923553501e9167b6caeaedcdeadf;hb=1cf24483a4b520177bfa539d9601749be6aef2ce;hp=bcdeb276453f33edd6db16674a188bee04b39777;hpb=85ab07d100a382467a42e19d741d403a7a96c951;p=senf.git diff --git a/senfscons/Mainpage.dox b/senfscons/Mainpage.dox index bcdeb27..7769355 100644 --- a/senfscons/Mainpage.dox +++ b/senfscons/Mainpage.dox @@ -58,7 +58,7 @@ namespace senfscons {
scons all_docs
Build documentation of all modules
scons all
Build all targets including binaries, libraries, documentation, - tests andpossible further targets
+ tests and possible further targets
scons -u doc
Run from within a module directory will build the documentation of that module
@@ -84,7 +84,7 @@ namespace senfscons { invokes the module \c SConscript files. To simplify the configuration, the SENFScons python package is provided. This package has helper utilities to simplify standard tasks. - In \c senfscons/SConstruct.tempalte you may find an example SConstruct file. Copy this to the + In \c senfscons/SConstruct.template you may find an example SConstruct file. Copy this to the project root (under the name \c SConstruct) to start a new project. You can then modify and configure it to your wishes. @@ -106,7 +106,7 @@ namespace senfscons { and have a prefix of \c Use. See \ref use. After all frameworks are configured, you can use SEFNScons.MakeEnvironment() to create a - corretly configured construction environment. + correctly configured construction environment. To configure the construction environment you can set Variables in the construction environment. See the SCons manpage for a list of supported variables. Some additional variables @@ -151,9 +151,14 @@ namespace senfscons { To configure the build environment to the local environment, a \c SConfig file may be created in the projects root directory. The supported parameters are -
\c CXX
C++ compiler to use
-
\c EXTRA_DEFINES
preprocessor symbols to be defined locally
-
\c EXTRA_LIBS
additional libraries needed for a local build
+
+
\c CXX
+
C++ compiler to use
+
\c EXTRA_DEFINES
+
preprocessor symbols to be defined locally
+
\c EXTRA_LIBS
+
additional libraries needed for a local build
+
Additionally, the \ref use define additional configuration variables which may be set here. */