Copyright: clarify and simplify the file headers
* Lumiera source code always was copyrighted by individual contributors
* there is no entity "Lumiera.org" which holds any copyrights
* Lumiera source code is provided under the GPL Version 2+
== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''
The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!
The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.
2024-11-17 23:42:55 +01:00
|
|
|
|
# coding: utf-8
|
2012-01-09 04:10:00 +01:00
|
|
|
|
##
|
|
|
|
|
|
## Options.py - SCons build: command line options and help
|
|
|
|
|
|
##
|
|
|
|
|
|
|
Copyright: clarify and simplify the file headers
* Lumiera source code always was copyrighted by individual contributors
* there is no entity "Lumiera.org" which holds any copyrights
* Lumiera source code is provided under the GPL Version 2+
== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''
The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!
The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.
2024-11-17 23:42:55 +01:00
|
|
|
|
# Copyright (C)
|
|
|
|
|
|
# 2012, Hermann Vosseler <Ichthyostega@web.de>
|
2012-01-09 04:10:00 +01:00
|
|
|
|
#
|
Copyright: clarify and simplify the file headers
* Lumiera source code always was copyrighted by individual contributors
* there is no entity "Lumiera.org" which holds any copyrights
* Lumiera source code is provided under the GPL Version 2+
== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''
The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!
The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.
2024-11-17 23:42:55 +01:00
|
|
|
|
# **Lumiera** is free software; you can redistribute it and/or modify it
|
|
|
|
|
|
# under the terms of the GNU General Public License as published by the
|
|
|
|
|
|
# Free Software Foundation; either version 2 of the License, or (at your
|
|
|
|
|
|
# option) any later version. See the file COPYING for further details.
|
2012-01-09 04:10:00 +01:00
|
|
|
|
#####################################################################
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-01-10 05:09:32 +01:00
|
|
|
|
from SCons.Script import PathVariable, EnumVariable, BoolVariable, Help
|
2012-01-09 04:10:00 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-01-10 05:09:32 +01:00
|
|
|
|
def defineCmdlineVariables(buildVars):
|
2012-01-09 04:10:00 +01:00
|
|
|
|
""" several toggles and configuration variables can be set on the commandline,
|
|
|
|
|
|
current settings will be persisted in a options cache file.
|
2025-06-07 23:59:57 +02:00
|
|
|
|
you may define custom variable settings in a separate file.
|
2012-01-09 04:10:00 +01:00
|
|
|
|
Commandline will override both.
|
|
|
|
|
|
"""
|
2012-01-10 05:09:32 +01:00
|
|
|
|
buildVars.AddVariables(
|
2012-01-09 04:10:00 +01:00
|
|
|
|
('ARCHFLAGS', 'Set architecture-specific compilation flags (passed literally to gcc)','')
|
|
|
|
|
|
,('CC', 'Set the C compiler to use.', 'gcc')
|
|
|
|
|
|
,('CXX', 'Set the C++ compiler to use.', 'g++')
|
|
|
|
|
|
,PathVariable('CCACHE', 'Integrate with CCache', '', PathVariable.PathAccept)
|
|
|
|
|
|
,PathVariable('DISTCC', 'Invoke C/C++ compiler commands through DistCC', '', PathVariable.PathAccept)
|
|
|
|
|
|
,EnumVariable('BUILDLEVEL', 'NoBug build level for debugging', 'ALPHA', allowed_values=('ALPHA', 'BETA', 'RELEASE'))
|
|
|
|
|
|
,BoolVariable('DEBUG', 'Build with debugging information and no optimisations', False)
|
|
|
|
|
|
,BoolVariable('OPTIMIZE', 'Build with strong optimisation (-O3)', False)
|
|
|
|
|
|
,BoolVariable('VALGRIND', 'Run Testsuite under valgrind control', True)
|
|
|
|
|
|
,BoolVariable('VERBOSE', 'Print full build commands', False)
|
2013-01-07 02:15:05 +01:00
|
|
|
|
,('TESTSUITES', 'Run only test suites matching the given pattern', '')
|
|
|
|
|
|
,('TESTMODE', 'test suite error mode for test.sh', '')
|
2012-01-09 04:10:00 +01:00
|
|
|
|
# ,BoolVariable('OPENGL', 'Include support for OpenGL preview rendering', False)
|
2025-06-07 23:59:57 +02:00
|
|
|
|
# ,EnumVariable('DIST_TARGET', 'Build target architecture', 'auto',
|
2012-01-09 04:10:00 +01:00
|
|
|
|
# allowed_values=('auto', 'i386', 'i686', 'x86_64' ), ignorecase=2)
|
|
|
|
|
|
,PathVariable('PREFIX', 'Installation dir prefix', 'usr/local', PathVariable.PathAccept)
|
|
|
|
|
|
,PathVariable('INSTALLDIR', 'Root output directory for install. Final installation will happen in INSTALLDIR/PREFIX/... ', '/', PathVariable.PathIsDir)
|
|
|
|
|
|
,PathVariable('PKGLIBDIR', 'Installation dir for plugins, defaults to PREFIX/lib/lumiera/modules', '',PathVariable.PathAccept)
|
|
|
|
|
|
,PathVariable('PKGDATADIR', 'Installation dir for default config, usually PREFIX/share/lumiera', '',PathVariable.PathAccept)
|
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-01-10 05:09:32 +01:00
|
|
|
|
def prepareOptionsHelp(buildVars,env):
|
2012-01-09 04:10:00 +01:00
|
|
|
|
prelude = """
|
|
|
|
|
|
USAGE: scons [-c] [OPTS] [key=val [key=val...]] [TARGETS]
|
|
|
|
|
|
Build and optionally install Lumiera.
|
|
|
|
|
|
Without specifying any target, just the (re)build target will run.
|
|
|
|
|
|
Add -c to the commandline to clean up anything a given target would produce
|
|
|
|
|
|
|
|
|
|
|
|
Special Targets:
|
|
|
|
|
|
build : just compile and link
|
|
|
|
|
|
research: build experimental code (might fail)
|
|
|
|
|
|
testcode: additionally compile the Testsuite
|
|
|
|
|
|
check : build and run the Testsuite
|
|
|
|
|
|
doc : generate documentation (Doxygen)
|
|
|
|
|
|
all : build and testcode and doc
|
|
|
|
|
|
install : install created artifacts at PREFIX
|
|
|
|
|
|
|
|
|
|
|
|
Configuration Options:
|
|
|
|
|
|
"""
|
2012-01-10 05:09:32 +01:00
|
|
|
|
Help(prelude + buildVars.GenerateHelpText(env))
|
2012-01-09 04:10:00 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|