F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Fix rendering issues due to excessive indentation

Browse Source
This commit is contained in:
Eduardo Almeida
2024-10-14 15:29:06 +01:00
parent f9b7ac722d
commit a92941c6ab
8 changed files with 207 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
doc/tutorial/source/data-collection.rst
View File

@@ -349,37 +349,37 @@ Supported Trace Types
The following traced values are supported with Probes as of this writing:
+------------------+-------------------+------------------------------------+
| TracedValue type | Probe type | File |
+==================+=========+=========+====================================+
| double | DoubleProbe | stats/model/double-probe.h |
+------------------+-------------------+------------------------------------+
| uint8_t | Uinteger8Probe | stats/model/uinteger-8-probe.h |
+------------------+-------------------+------------------------------------+
| uint16_t | Uinteger16Probe | stats/model/uinteger-16-probe.h |
+------------------+-------------------+------------------------------------+
| uint32_t | Uinteger32Probe | stats/model/uinteger-32-probe.h |
+------------------+-------------------+------------------------------------+
| bool | BooleanProbe | stats/model/uinteger-16-probe.h |
+------------------+-------------------+------------------------------------+
| ns3::Time | TimeProbe | stats/model/time-probe.h |
+------------------+-------------------+------------------------------------+
+------------------+-------------------+------------------------------------+
| TracedValue type | Probe type | File |
+==================+=========+=========+====================================+
| double | DoubleProbe | stats/model/double-probe.h |
+------------------+-------------------+------------------------------------+
| uint8_t | Uinteger8Probe | stats/model/uinteger-8-probe.h |
+------------------+-------------------+------------------------------------+
| uint16_t | Uinteger16Probe | stats/model/uinteger-16-probe.h |
+------------------+-------------------+------------------------------------+
| uint32_t | Uinteger32Probe | stats/model/uinteger-32-probe.h |
+------------------+-------------------+------------------------------------+
| bool | BooleanProbe | stats/model/uinteger-16-probe.h |
+------------------+-------------------+------------------------------------+
| ns3::Time | TimeProbe | stats/model/time-probe.h |
+------------------+-------------------+------------------------------------+
The following TraceSource types are supported by Probes as of this writing:
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
| TracedSource type | Probe type | Probe outputs | File |
+==========================================+========================+===============+====================================================+
| Ptr<const Packet> | PacketProbe | OutputBytes | network/utils/packet-probe.h |
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
| Ptr<const Packet>, Ptr<Ipv4>, uint32_t | Ipv4PacketProbe | OutputBytes | internet/model/ipv4-packet-probe.h |
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
| Ptr<const Packet>, Ptr<Ipv6>, uint32_t | Ipv6PacketProbe | OutputBytes | internet/model/ipv6-packet-probe.h |
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
| Ptr<const Packet>, Ptr<Ipv6>, uint32_t | Ipv6PacketProbe | OutputBytes | internet/model/ipv6-packet-probe.h |
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
| Ptr<const Packet>, const Address& | ApplicationPacketProbe | OutputBytes | applications/model/application-packet-probe.h |
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
| TracedSource type | Probe type | Probe outputs | File |
+==========================================+========================+===============+====================================================+
| Ptr<const Packet> | PacketProbe | OutputBytes | network/utils/packet-probe.h |
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
| Ptr<const Packet>, Ptr<Ipv4>, uint32_t | Ipv4PacketProbe | OutputBytes | internet/model/ipv4-packet-probe.h |
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
| Ptr<const Packet>, Ptr<Ipv6>, uint32_t | Ipv6PacketProbe | OutputBytes | internet/model/ipv6-packet-probe.h |
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
| Ptr<const Packet>, Ptr<Ipv6>, uint32_t | Ipv6PacketProbe | OutputBytes | internet/model/ipv6-packet-probe.h |
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
| Ptr<const Packet>, const Address& | ApplicationPacketProbe | OutputBytes | applications/model/application-packet-probe.h |
+------------------------------------------+------------------------+---------------+----------------------------------------------------+
As can be seen, only a few trace sources are supported, and they are all
oriented towards outputting the Packet size (in bytes). However,

60
doc/tutorial/source/tracing.rst
View File

@@ -452,7 +452,7 @@ Let's ignore the bit about context for now.
Finally, the line assigning a value to ``m_myInt``::
myObject->m_myInt = 1234;
myObject->m_myInt = 1234;
should be interpreted as an invocation of ``operator=`` on the member
variable ``m_myInt`` with the integer ``1234`` passed as a parameter.
@@ -712,12 +712,12 @@ you select the "API Documentation" link, you will be taken to the
In the sidebar you should see a hierarchy that begins
* ns-3
* ns-3
* ns-3 Documentation
* All TraceSources
* All Attributes
* All GlobalValues
* ns-3 Documentation
* All TraceSources
* All Attributes
* All GlobalValues
The list of interest to us here is "All TraceSources". Go ahead and
select that link. You will see, perhaps not too surprisingly, a list
@@ -1168,23 +1168,23 @@ itself around, rather than passing the address of the object. We
extend that requirement to include the full set of assignment-style
operators that are pre-defined for plain-old-data (POD) types:
+---------------------+---------------------+
| ``operator=`` (assignment) |
+---------------------+---------------------+
| ``operator*=`` | ``operator/=`` |
+---------------------+---------------------+
| ``operator+=`` | ``operator-=`` |
+---------------------+---------------------+
| ``operator++`` (both prefix and postfix) |
+---------------------+---------------------+
| ``operator--`` (both prefix and postfix) |
+---------------------+---------------------+
| ``operator<<=`` | ``operator>>=`` |
+---------------------+---------------------+
| ``operator&=`` | ``operator|=`` |
+---------------------+---------------------+
| ``operator%=`` | ``operator^=`` |
+---------------------+---------------------+
+---------------------+---------------------+
| ``operator=`` (assignment) |
+---------------------+---------------------+
| ``operator*=`` | ``operator/=`` |
+---------------------+---------------------+
| ``operator+=`` | ``operator-=`` |
+---------------------+---------------------+
| ``operator++`` (both prefix and postfix) |
+---------------------+---------------------+
| ``operator--`` (both prefix and postfix) |
+---------------------+---------------------+
| ``operator<<=`` | ``operator>>=`` |
+---------------------+---------------------+
| ``operator&=`` | ``operator|=`` |
+---------------------+---------------------+
| ``operator%=`` | ``operator^=`` |
+---------------------+---------------------+
What this all really means is that you will be able to trace all
changes made using those operators to a C++ object which has value
@@ -2424,13 +2424,13 @@ behaving identically, but we do strive to make them all work as
similarly as possible; and whenever possible there are analogs for all
methods in all classes.
+-----------------+---------+---------+
| | PCAP | ASCII |
+=================+=========+=========+
| Device Helper | |check| | |check| |
+-----------------+---------+---------+
| Protocol Helper | |check| | |check| |
+-----------------+---------+---------+
+-----------------+---------+---------+
| | PCAP | ASCII |
+=================+=========+=========+
| Device Helper | |check| | |check| |
+-----------------+---------+---------+
| Protocol Helper | |check| | |check| |
+-----------------+---------+---------+
We use an approach called a ``mixin`` to add tracing functionality to
our helper classes. A ``mixin`` is a class that provides