From d33563b5e46687f26bd0f9d4536ff53da362bbf9 Mon Sep 17 00:00:00 2001 From: YunQiang Su Date: Sun, 14 Aug 2011 14:21:41 -0700 Subject: [PATCH] bug 1177: auto generated man pages have error --- doc/manual/source/attributes.rst | 4 ++-- src/click/doc/click.rst | 2 +- src/mpi/doc/distributed.rst | 2 +- src/network/doc/sockets-api.rst | 18 +++++++++--------- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/manual/source/attributes.rst b/doc/manual/source/attributes.rst index 3ce1c11ad..1c842bf95 100644 --- a/doc/manual/source/attributes.rst +++ b/doc/manual/source/attributes.rst @@ -767,8 +767,8 @@ 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-examples --enable-tests step::: +To check whether it is configured or not, check the output of the step::: +./waf configure --enable-examples --enable-tests ---- Summary of optional NS-3 features: Threading Primitives : enabled diff --git a/src/click/doc/click.rst b/src/click/doc/click.rst index 06367daca..70efe9778 100644 --- a/src/click/doc/click.rst +++ b/src/click/doc/click.rst @@ -119,7 +119,7 @@ From any point within a Click graph, you may use the Print (http://read.cs.ucla. -> ToDump(out_arpquery,PER_NODE 1) -> ethout; -...will print the contents of packets that flow out of the ArpQuerier, then generate a pcap trace file which will have a suffix 'out_arpquery', for each node using the Click file, before pushing packets onto 'ethout'. +and ...will print the contents of packets that flow out of the ArpQuerier, then generate a pcap trace file which will have a suffix 'out_arpquery', for each node using the Click file, before pushing packets onto 'ethout'. Helper ====== diff --git a/src/mpi/doc/distributed.rst b/src/mpi/doc/distributed.rst index d7fa44eb0..bda795c16 100644 --- a/src/mpi/doc/distributed.rst +++ b/src/mpi/doc/distributed.rst @@ -125,7 +125,7 @@ Configure |ns3| with the --enable-mpi option::: Ensure that MPI is enabled by checking the optional features shown from the output of configure. -Next, build |ns3|: +Next, build |ns3|::: ./waf diff --git a/src/network/doc/sockets-api.rst b/src/network/doc/sockets-api.rst index 8b8f8900c..350cdeade 100644 --- a/src/network/doc/sockets-api.rst +++ b/src/network/doc/sockets-api.rst @@ -125,16 +125,16 @@ sending of more data until a function registered at the :cpp:func:`ns3::Socket::SetSendCallback` callback is invoked. An application can also ask the socket how much space is available by calling :cpp:func:`ns3::Socket::GetTxAvailable`. A typical sequence -of events for sending data (ignoring connection setup) might be: +of events for sending data (ignoring connection setup) might be::: -* ``SetSendCallback (MakeCallback(&HandleSendCallback));`` -* ``Send ();`` -* ``Send ();`` -* ... -* Send fails because buffer is full -* wait until :cpp:func:`HandleSendCallback` is called -* :cpp:func:`HandleSendCallback` is called by socket, since space now available -* ``Send (); // Start sending again`` + * ``SetSendCallback (MakeCallback(&HandleSendCallback));`` + * ``Send ();`` + * ``Send ();`` + * ... + * Send fails because buffer is full + * wait until :cpp:func:`HandleSendCallback` is called + * :cpp:func:`HandleSendCallback` is called by socket, since space now available + * ``Send (); // Start sending again`` Similarly, on the receive side, the socket user does not block on a call to ``recv()``. Instead, the application sets a callback