From 1f9ea7d2ef55f8ba3a9075ece4ffc4ff3f81a9f2 Mon Sep 17 00:00:00 2001
From: Mitch Watrous <watrous@u.washington.edu>
Date: Tue, 12 Apr 2011 14:35:16 -0700
Subject: [PATCH] Make examples not be built by default

---
 CHANGES.html                                |  8 +++----
 doc/build.txt                               |  4 ++--
 doc/manual/source/attributes.rst            |  4 ++--
 doc/manual/source/click.rst                 |  2 +-
 doc/manual/source/distributed.rst           |  2 +-
 doc/manual/source/openflow-switch.rst       |  2 +-
 doc/manual/source/tcp.rst                   |  2 +-
 doc/release_steps.txt                       |  2 +-
 doc/testing/source/testing-framework.rst    |  5 ++--
 doc/tutorial/source/conceptual-overview.rst |  4 ++--
 doc/tutorial/source/getting-started.rst     | 26 ++++++++++-----------
 utils.py                                    |  6 ++---
 utils/.ns3rc                                |  2 +-
 wscript                                     |  4 ++--
 14 files changed, 37 insertions(+), 36 deletions(-)

diff --git a/CHANGES.html b/CHANGES.html
index 34a35e960..ab80d15b8 100644
--- a/CHANGES.html
+++ b/CHANGES.html
@@ -48,17 +48,17 @@ us a note on ns-developers mailing list.  </p>
 
 <h2>Changes to build system:</h2>
 <ul>
-<li><b>Tests are no longer built by default in ns-3</b>
+<li><b>Examples and tests are no longer built by default in ns-3</b>
 <p>
-You can now make tests be built in ns-3 in two ways.
+You can now make examples and tests be built in ns-3 in two ways.
 <ol>
 <li> Using build.py when ns-3 is built for the first time:
 <pre>
-    ./build.py --enable-tests
+    ./build.py --enable-examples --enable-tests
 </pre>
 <li> Using waf once ns-3 has been built:
 <pre>
-    ./waf configure --enable-tests
+    ./waf configure --enable-examples --enable-tests
 </pre>
 </ol>
 </p></li>
diff --git a/doc/build.txt b/doc/build.txt
index c82b48d9c..2db77ebe0 100644
--- a/doc/build.txt
+++ b/doc/build.txt
@@ -36,8 +36,8 @@ The resulting binaries are placed in build/<debuglevel>/srcpath.
 
 Other waf usages include:
 
- 1. ./waf configure --enable-tests
-    Turn on unit tests.
+ 1. ./waf configure --enable-examples --enable-tests
+    Turn on examples and tests.
 
  2. ./waf --doxygen
     Run doxygen to generate documentation
diff --git a/doc/manual/source/attributes.rst b/doc/manual/source/attributes.rst
index 39125f35d..9bfca344b 100644
--- a/doc/manual/source/attributes.rst
+++ b/doc/manual/source/attributes.rst
@@ -768,7 +768,7 @@ Ubuntu installation command is:::
     sudo apt-get install libgtk2.0-0 libgtk2.0-dev
 
 To check whether it is configured or not, check the output of the
-./waf configure --enable-tests step:::
+./waf configure --enable-examples --enable-tests step:::
 
     ---- Summary of optional NS-3 features:
     Threading Primitives          : enabled
@@ -776,7 +776,7 @@ To check whether it is configured or not, check the output of the
     GtkConfigStore                : not enabled (library 'gtk+-2.0 >= 2.12' not found)
 
 In the above example, it was not enabled, so it cannot be used until a suitable
-version is installed and ./waf configure --enable-tests; ./waf is rerun.
+version is installed and ./waf configure --enable-examples --enable-tests; ./waf is rerun.
 
 Usage is almost the same as the non-GTK-based version, but there
 are no ConfigStore attributes involved:::
diff --git a/doc/manual/source/click.rst b/doc/manual/source/click.rst
index 42141610e..809a27e50 100644
--- a/doc/manual/source/click.rst
+++ b/doc/manual/source/click.rst
@@ -73,7 +73,7 @@ The --enable-wifi flag may be skipped if you don't intend on using Click with Wi
 Once Click has been built successfully, change into the ns-3 directory and 
 configure ns-3 with Click Integration support::
 
-  $: ./waf configure --enable-tests --with-nsclick=/path/to/click/source
+  $: ./waf configure --enable-examples --enable-tests --with-nsclick=/path/to/click/source
 
 If it says 'enabled' beside 'NS-3 Click Integration Support', then you're good to go.
 
diff --git a/doc/manual/source/distributed.rst b/doc/manual/source/distributed.rst
index ef5b0d81c..a67be570b 100644
--- a/doc/manual/source/distributed.rst
+++ b/doc/manual/source/distributed.rst
@@ -118,7 +118,7 @@ If you already built |ns3| without MPI enabled, you must re-build:::
 
 Configure |ns3| with the --enable-mpi option:::
 
-    ./waf -d debug configure --enable-tests --enable-mpi
+    ./waf -d debug configure --enable-examples --enable-tests --enable-mpi
 
 Ensure that MPI is enabled by checking the optional features shown from the
 output of configure.
diff --git a/doc/manual/source/openflow-switch.rst b/doc/manual/source/openflow-switch.rst
index 0fa126dc7..fec813fe9 100644
--- a/doc/manual/source/openflow-switch.rst
+++ b/doc/manual/source/openflow-switch.rst
@@ -143,7 +143,7 @@ the library. From the "openflow" directory, run:::
 link to an ns-3 build with this OpenFlow switch module, run from the ns-3-dev
 (or whatever you have named your distribution):::
 
-  $ ./waf configure --enable-tests --with-openflow=path/to/openflow
+  $ ./waf configure --enable-examples --enable-tests --with-openflow=path/to/openflow
 
 #3 Under ``---- Summary of optional NS-3 features:`` you should see:::
 
diff --git a/doc/manual/source/tcp.rst b/doc/manual/source/tcp.rst
index 5ede7b143..1360c9914 100644
--- a/doc/manual/source/tcp.rst
+++ b/doc/manual/source/tcp.rst
@@ -164,7 +164,7 @@ Using the ``build.py`` script in ns-3-allinone directory, NSC will be enabled by
 default unless the platform does not support it. To disable it when building
 |ns3|, type:::
 
-./waf configure --enable-tests --disable-nsc
+./waf configure --enable-examples --enable-tests --disable-nsc
 
 Building and validating
 +++++++++++++++++++++++
diff --git a/doc/release_steps.txt b/doc/release_steps.txt
index c10174a32..f1b710581 100644
--- a/doc/release_steps.txt
+++ b/doc/release_steps.txt
@@ -48,7 +48,7 @@ Steps in doing an ns-3 release
    - cd ns-3.x
    - ./test.py
    - ./test.py -g
-   - ./waf -d optimized --enable-tests configure
+   - ./waf -d optimized --enable-examples --enable-tests configure
    - ./waf
    - ./test.py
    - ./test.py -g
diff --git a/doc/testing/source/testing-framework.rst b/doc/testing/source/testing-framework.rst
index 20bf0a0c9..25a0e56fb 100644
--- a/doc/testing/source/testing-framework.rst
+++ b/doc/testing/source/testing-framework.rst
@@ -64,11 +64,12 @@ as well.
 ``test.py`` is very flexible in allowing the user to specify the number
 and kind of tests to run; and also the amount and kind of output to generate.
 
-Before running ``test.py``, make sure that ns3's tests have been built by doing the following
+Before running ``test.py``, make sure that ns3's examples and tests
+have been built by doing the following
 
 ::
 
-  ./waf configure --enable-tests
+  ./waf configure --enable-examples --enable-tests
   ./waf
 
 By default, ``test.py`` will run all available tests and report status
diff --git a/doc/tutorial/source/conceptual-overview.rst b/doc/tutorial/source/conceptual-overview.rst
index ce82113ce..0eb7d8938 100644
--- a/doc/tutorial/source/conceptual-overview.rst
+++ b/doc/tutorial/source/conceptual-overview.rst
@@ -249,10 +249,10 @@ already have done a
 
 ::
 
-  ./waf -d debug --enable-tests configure
+  ./waf -d debug --enable-examples --enable-tests configure
 
 in order to configure the project to perform debug builds that include 
-tests.  You will also have done a
+examples and tests.  You will also have done a
 
 ::
 
diff --git a/doc/tutorial/source/getting-started.rst b/doc/tutorial/source/getting-started.rst
index 61fa568cd..dbadeb8ea 100644
--- a/doc/tutorial/source/getting-started.rst
+++ b/doc/tutorial/source/getting-started.rst
@@ -264,12 +264,12 @@ breath and type the following:
 
 ::
 
-  ./build.py --enable-tests
+  ./build.py --enable-examples --enable-tests
 
-Because we are working with tests in this tutorial, and because they
-are not built by default in |ns3|, the argument for build.py tells it
-to build them for us.  In the future you can build |ns3| without tests
-if you wish.
+Because we are working with examples and tests in this tutorial, and
+because they are not built by default in |ns3|, the arguments for
+build.py tells it to build them for us.  In the future you can build
+|ns3| without examples and tests if you wish.
 
 You will see lots of typical compiler output messages displayed as the build
 script builds the various pieces you downloaded.  Eventually you should see the
@@ -300,12 +300,12 @@ Probably the most useful configuration change you can make will be to
 build the optimized version of the code.  By default you have configured
 your project to build the debug version.  Let's tell the project to 
 make an optimized build.  To explain to Waf that it should do optimized
-builds that include the tests, you will need to execute the 
+builds that include the examples and tests, you will need to execute the 
 following command,
 
 ::
 
-  ./waf -d optimized --enable-tests configure
+  ./waf -d optimized --enable-examples --enable-tests configure
 
 This runs Waf out of the local directory (which is provided as a convenience
 for you).  As the build system checks for various dependencies you should see
@@ -379,11 +379,11 @@ would not be enabled and a message would be displayed.  Note further that there
 a feature to use the program ``sudo`` to set the suid bit of certain programs.
 This is not enabled by default and so this feature is reported as "not enabled."
 
-Now go ahead and switch back to the debug build that includes the tests.
+Now go ahead and switch back to the debug build that includes the examples and tests.
 
 ::
 
-  ./waf -d debug --enable-tests configure
+  ./waf -d debug --enable-examples --enable-tests configure
 
 The build system is now configured and you can build the debug versions of 
 the |ns3| programs by simply typing,
@@ -396,11 +396,11 @@ Some waf commands are meaningful during the build phase and some commands are va
 in the configuration phase.  For example, if you wanted to use the emulation 
 features of |ns3|, you might want to enable setting the suid bit using
 sudo as described above.  This turns out to be a configuration-time command, and so 
-you could reconfigure using the following command that also includes the tests
+you could reconfigure using the following command that also includes the examples and tests
 
 ::
 
-  ./waf -d debug --enable-sudo --enable-tests configure
+  ./waf -d debug --enable-sudo --enable-examples --enable-tests configure
 
 If you do this, waf will have run sudo to change the socket creator programs of the
 emulation code to run as root.  There are many other configure- and build-time options
@@ -499,10 +499,10 @@ type the following,
 
 ::
 
-  ./waf -d debug --enable-tests configure
+  ./waf -d debug --enable-examples --enable-tests configure
 
 to tell ``waf`` to build the debug versions of the |ns3| 
-programs that includes the tests.  You must still build 
+programs that includes the examples and tests.  You must still build 
 the actual debug version of the code by typing,
 
 ::
diff --git a/utils.py b/utils.py
index 4ffe9632d..fb57005a3 100644
--- a/utils.py
+++ b/utils.py
@@ -85,10 +85,10 @@ def read_config_file():
 
     '''
 
-    # By default, all modules will be enabled, examples will be enabled,
+    # By default, all modules will be enabled, examples will be disabled,
     # and tests will be disabled.
     modules_enabled  = ['all_modules']
-    examples_enabled = True
+    examples_enabled = False
     tests_enabled    = False
 
     # See if the ns3 configuration file exists in the current working
@@ -111,7 +111,7 @@ def read_config_file():
         modules_enabled = ['all_modules']
 
     # Read in whether examples should be enabled or not.
-    value_if_missing = True
+    value_if_missing = False
     examples_enabled = get_bool_from_file(dot_ns3rc_path, 'examples_enabled', value_if_missing)
 
     # Read in whether tests should be enabled or not.
diff --git a/utils/.ns3rc b/utils/.ns3rc
index 8d88d94fb..41316712e 100644
--- a/utils/.ns3rc
+++ b/utils/.ns3rc
@@ -7,7 +7,7 @@
 modules_enabled = ['all_modules']
 
 # Set this equal to true if you want examples to be run.
-examples_enabled = True
+examples_enabled = False
 
 # Set this equal to true if you want tests to be run.
 tests_enabled = False
diff --git a/wscript b/wscript
index fe33c46c3..9efbb93cb 100644
--- a/wscript
+++ b/wscript
@@ -30,10 +30,10 @@ import Scripting
 
 from utils import read_config_file
 
-# By default, all modules will be enabled, examples will be enabled,
+# By default, all modules will be enabled, examples will be disabled,
 # and tests will be disabled.
 modules_enabled  = ['all_modules']
-examples_enabled = True
+examples_enabled = False
 tests_enabled    = False
 
 # Get the information out of the NS-3 configuration file.