update tutorial section on bake environment variables
authorTom Henderson <tomh@tomh.org>
Wed, 26 Nov 2014 16:03:44 -0800
changeset 11077 5c8dea49a671
parent 11076 9f1b2646efa6
child 11080 e1da5648e87a
update tutorial section on bake environment variables
doc/tutorial/source/getting-started.rst
--- a/doc/tutorial/source/getting-started.rst	Wed Nov 26 15:15:34 2014 -0800
+++ b/doc/tutorial/source/getting-started.rst	Wed Nov 26 16:03:44 2014 -0800
@@ -182,15 +182,20 @@
 and installing libraries into a build directory.  bake can be run
 by referencing the binary, but if one chooses to run bake from
 outside of the directory it was downloaded into, it is advisable
-to put bake into your path, such as follows (Linux bash shell example)::
+to put bake into your path, such as follows (Linux bash shell example).
+First, change into the 'bake' directory, and then set the following
+environment variables
+
+::
 
-  $ export BAKE_HOME=`pwd`/bake
-  $ export PATH=$PATH:$BAKE_HOME
-  $ export PYTHONPATH=$PYTHONPATH:$BAKE_HOME
+  $ export BAKE_HOME=`pwd`
+  $ export PATH=$PATH:$BAKE_HOME:$BAKE_HOME/build/bin
+  $ export PYTHONPATH=$PYTHONPATH:$BAKE_HOME:$BAKE_HOME/build/lib
 
-However, setting environment variables is not strictly necessary to
-complete this tutorial, so we'll call bake directly by specifying the path 
-to it in our shell commands.
+This will put the bake.py program into the shell's path, and will allow
+other programs to find executables and libraries created by bake.  Although
+several bake use cases do not require setting PATH and PYTHONPATH as above,
+full builds of ns-3-allinone (with the optional packages) typically do.
 
 Step into the workspace directory and type the following into your shell::