Toplevel directory cleanup
[senf.git] / tools / _templates / Example.SConscript
1 # -*- python -*-
2
3 Import('env')
4 import SENFSCons
5
6 ###########################################################################
7
8 ## Most modules will be built using the auto macros from site_scons/SENFSCons.py 
9 ## (see below). Arguments are:
10 ##     env - The construction environment
11 ##     name - name of target (AutoPacketBundle only)
12 ##     exclude - Files to exclude from the build
13 ##     subdirs - Subdirectories to recurse into
14 ##     doc_extra_sources - Extra source files (images) to build for the documentation
15 ##
16 ## If the macros don't do exactly what you want you may either copy the function definition
17 ## body from site_scons/SENFSCons.py into the SConscript file or add additional targets
18
19 ## Build a standard library module
20 #
21 # SENFSCons.AutoRules(env, exclude=[...], subdirs=[...], doc_extra_sources=[...]
22
23 ## Build a packet bundle
24 #
25 # SENFSCons.AutoPacketBundle(env, name, exclude=[...], subdirs=[...], doc_extra_sources=[...]
26
27 ## Build an (additional) executable. Build it as default target (built when calling scons
28 ## without arguments or with the 'default' argument
29 #
30 # env.Default(env.Program(name, [ sources...]))