documentation: Clear Sphinx warnings

This commit is contained in:
Tom Henderson
2018-08-05 17:12:43 -07:00
parent 2986b7a324
commit 34cd6172ba
3 changed files with 26 additions and 1 deletions

View File

@@ -605,6 +605,8 @@ devices (which in this simple example has the same effect as the previous
If you run this program from the command line, you should see the following
output corresponding to the steps we took above::
.. sourcecode:: text
$ ./waf --run main-attribute-value
1. dtq limit: 80p
2. txQueue limit: 80p

View File

@@ -302,6 +302,8 @@ Set up a ``bake`` build environment
Try the following commands::
.. sourcecode:: bash
$ cd bake
$ export BAKE_HOME=`pwd`
$ export PATH=$PATH:$BAKE_HOME/build/bin
@@ -314,15 +316,21 @@ Configure
Perform a configuration at the bake level::
.. sourcecode:: bash
$ ./bake.py configure -e ns-3-dev -e pygccxml-1.9.1
The output of ``bake show`` should show something like this:
::
.. sourcecode:: bash
$ ./bake.py show
Should say::
.. sourcecode:: text
-- System Dependencies --
> clang-dev - OK
> g++ - OK
@@ -333,12 +341,13 @@ Should say::
> qt - OK
> setuptools - OK
Download
########
Try the following command::
.. sourcecode:: bash
$ ./bake.py download
>> Searching for system dependency python-dev - OK
>> Searching for system dependency clang-dev - OK
@@ -359,6 +368,8 @@ Build
Try the following commands::
.. sourcecode:: text
$ mkdir -p build/lib
$ ./bake.py build
@@ -369,12 +380,16 @@ support is enabled:
::
.. sourcecode:: text
Python API Scanning Support : enabled
It may say something like this, if the support is not active:
::
.. sourcecode:: text
Python API Scanning Support : not enabled (Missing 'pygccxml' Python module)
In this case, the user must take steps to install castxml and pygccxml;
@@ -405,6 +420,8 @@ To re-scan a module:
::
.. sourcecode:: bash
$ cd source/ns-3-dev
$ ./waf --apiscan=wifi

View File

@@ -111,6 +111,8 @@ The example for TBF is `tbf-example.cc` located in ``examples/traffic-control/``
::
.. sourcecode:: bash
$ ./waf --run "tbf-example --PrintHelp"
$ ./waf --run "tbf-example --burst=125000 --rate=1Mbps --peakRate=1.5Mbps"
@@ -130,6 +132,8 @@ The test suite can be run using the following commands:
::
.. sourcecode:: bash
$ ./waf configure --enable-examples --enable-tests
$ ./waf build
$ ./test.py -s tbf-queue-disc
@@ -138,4 +142,6 @@ or
::
.. sourcecode:: bash
$ NS_LOG="TbfQueueDisc" ./waf --run "test-runner --suite=tbf-queue-disc"