Changeset 623:b4b839410185

Timestamp:

08/14/08 19:46:39 (3 months ago)

Author:

David Anderson <dave@…>

Branch:

default

Message:

Add a help message to the SConstruct file.

This help explains to new users how to build application kernels, which is
not obvious from reading the SConstruct.

Files:

• nxos/SConstruct (modified) (1 diff)

nxos/SConstruct

@@ -156 +156 @@
 opts = Options('build_flags.py')
 opts.Add(ListOption('appkernels',
-                    'List of application kernels to build', 'tests',
+                    'List of application kernels to build '
+                    '(by default, only the tests kernel is compiled', 'tests',
                     buildable_systems))
+
+Help('''
+Type: 'scons appkernels=...' to build kernels.
+
+The application kernel names are the directory names in the systems/
+subdirectory. You can specify several application kernels, separated
+by commas.  If you specify no app kernel, only the tests kernel is
+built.
+
+Examples
+
+ - Build the Marvin application kernel:
+     scons appkernels=marvin
+
+ - Build both Marvin and the tests kernel:
+     scons appkernels=tests,marvin
+
+ - Build all available systems (may require extra external dependencies):
+     scons appkernels=all
+
+ - Build only the baseplate code:
+     scons appkernels=none
+''')
 
 ###############################################################