Update scons section and add -h option

1 files changed, 45 insertions, 1 deletions

diff --git a/index.html b/index.html
index 6961509..f820371 100644
--- a/index.html
+++ b/index.html
@@ -380,8 +380,52 @@ make modules
     depends on the LITMUS<sup>RT</sup> kernel kernel and provides its own build system (based on <a href="http://www.scons.org/">scons</a>). 

     In order to compile <span class="src">liblitmus</span>, you need to adjust the

     variable <span class="src">LITMUS_KERNEL</span> in the <span class="src">SConstruct</span> file to point to your 

-    copy of the kernel.

+    copy of the kernel. Users should not update the <span class="src">SConstruct</span> file manually anymore. Instead, a <span class="src">.config</span> file can be created with appropriate variables. The required variables can be listed using <span class="src"> scons -h </span> command. This command lists the variables required for building the <span class="src"> liblitmus2010 </span> library. <br>

+   Sample output of <span class="src"> scons -h </span> is as shown below.

     </p> 

+   <p>

+   <pre class="shell"> 

+scons -h

+scons: Reading SConscript files ...

+scons: done reading SConscript files.

+

+=============================================

+liblitmus --- The LITMUS^RT Userspace Library

+

+There are a number of user-configurable build

+variables. These can either be set on the

+command line (e.g., scons ARCH=x86) or read

+from a local configuration file (.config).

+

+Run 'scons --dump-config' to see the final

+build configuration.

+

+Build Variables

+---------------

+

+LITMUS_KERNEL: Where to find the LITMUS^RT kernel. ( /path/to/LITMUS_KERNEL )

+    default: ../litmus2010

+    actual: ../litmus2010

+

+PYTHON_HEADERS: Where to find Python headers. ( /path/to/PYTHON_HEADERS )

+    default: /usr/include/python2.5

+    actual: /usr/include/python2.5

+

+ARCH: Target architecture. (x86_64|sparc64|x86|i686)

+    default: x86_64

+    actual: x86_64

+

+WSS: Working set size for pm analysis

+    default: 3072

+    actual: 3072

+

+Use scons -H for help about command-line options.

+   </pre>

+</p>

+<p class="notopmargin">

+ To summarize, the <span class="src"> liblitmus </span> can be obtained and

+    compiled with the following commands:

+</p>

 <pre class="shell"> 

 cd $DIR

 wget http://www.cs.unc.edu/~anderson/litmus-rt/download/2010.1/liblitmus-2010.1.tgz