Skip to content

Commit 0d63dc6

Browse files
committed
doc: removed/renamed/fixed stale or incorrect references in documentation
1 parent dd81f1d commit 0d63dc6

File tree

9 files changed

+8
-27
lines changed

9 files changed

+8
-27
lines changed

doc/src/developers-guide/ch-ipv4.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,8 @@ a multicast address or not.
198198
When the datagram is decided to be sent up, it is processed as described
199199
in the previous subsection (Receiving packets). If it is decided to be
200200
sent out through some interface, it is actually sent to the :ned:`Arp`
201-
module through the ``queueOut`` gate. An :msg:`IPv4RoutingDecision`
202-
control info is attached to the outgoing packet, containing the outgoing
201+
module through the ``queueOut`` gate. An :msg:`NextHopAddressReq` and a :msg:`InterfaceReq`
202+
tag is attached to the outgoing packet, containing the outgoing
203203
interface id and the IP address of the next hop. The :ned:`Arp` module
204204
resolves the IP address to a hardware address if needed and forwards the
205205
datagram to the next hop.
@@ -418,8 +418,7 @@ calling :fun:`ICMPAccess::get()`.
418418
When an incoming ICMP error message is received, the :ned:`Icmp` module
419419
sends it out on the ``errorOut`` gate unchanged. It is assumed that
420420
an external module is connected to ``errOut`` that can process the
421-
error packet. There is a simple module (:ned:`ErrorHandling`) that
422-
simply logs the error and drops the message. Note that the :ned:`Ipv4`
421+
error packet. Note that the :ned:`Ipv4`
423422
module does not send REDIRECT, DESTINATION_UNREACHABLE, TIME_EXCEEDED,
424423
and PARAMETER_PROBLEM messages to the :ned:`Icmp` module; it will send
425424
them to the transport layer module that sent the bogus packet

doc/src/developers-guide/ch-tags.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ service primitives; the other two are only present for completeness. The request
188188
service primitive is used when a higher layer protocol module (e.g., :ned:`Tcp`)
189189
wants to deliver a packet to a lower layer protocol module (e.g., :ned:`Ipv4`).
190190
Similarly, the :cpp:`SP_INDICATION` service primitive is used when a lower layer
191-
protocol module (e.g., :ned:`Ethernet`) wants to deliver a packet to a higher layer
191+
protocol module (e.g., Ethernet) wants to deliver a packet to a higher layer
192192
protocol module (e.g., :ned:`Ipv4`).
193193

194194
Determining the Next Protocol

doc/src/developers-guide/ch-tcp.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,8 +177,7 @@ messages they communicate with. Sometimes it is enough to simulate the
177177
amount of data transmitted (“200 MB”), and contents do not matter. In
178178
other scenarios, contents matter a lot. The messages can be represented
179179
as a stream of bytes, but sometimes it is easier for the applications to
180-
pass message objects to each other (e.g. HTTP request represented by a
181-
:msg:`HTTPRequest` message class).
180+
pass message objects to each other.
182181

183182
The TCP modules in the INET framework support 3 data transfer modes:
184183

doc/src/users-guide/ch-diffserv.rst

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ packet. It can be used to discard excess traffic, i.e. packets whose
221221
arrival rate exceeds the allowed maximum. In INET, the :ned:`Sink` module
222222
can be used as an absolute dropper.
223223

224-
The algorithmic droppers in INET are :ned:`ThresholdDropper` and
224+
The algorithmic droppers in INET are :ned:`OrdinalBasedDropper` and
225225
:ned:`RedDropper`. These modules have multiple input and multiple output
226226
gates. Packets that arrive on gate :gate:`in[i]` are forwarded to gate
227227
:gate:`out[i]` (unless they are dropped). However, the queues attached to
@@ -230,23 +230,7 @@ of the dropping algorithm is the sum of the individual queue lengths.
230230
This way, we can emulate shared buffers of the queues. Note that it is
231231
also possible to connect each output to the same queue module.
232232

233-
.. _ug:sec:diffserv:threshold-dropper:
234-
235-
Threshold Dropper
236-
^^^^^^^^^^^^^^^^^
237-
238-
The :ned:`ThresholdDropper` module selectively drops packets based on
239-
the available buffer space of the queues attached to its output. The
240-
buffer space can be specified as the count of packets or as the size in
241-
bytes.
242-
243-
The module sums the buffer lengths of its outputs, and if enqueuing a
244-
packet would exceed the configured capacities, then the packet will be
245-
dropped instead.
246-
247-
By attaching a :ned:`ThresholdDropper` to the input of a FIFO queue, you
248-
can compose a drop tail queue. Shared buffer space can be modeled by
249-
attaching more FIFO queues to the output.
233+
.. _ug:sec:diffserv:red-dropper:
250234

251235
RED Dropper
252236
^^^^^^^^^^^
File renamed without changes.

showcases/tsn/trafficshaping/htbshaper/doc/index.rst renamed to showcases/tsn/trafficshaping/htbshaper/doc/index.rst.todo

File renamed without changes.

showcases/tsn/trafficshaping/tokenbucketshaper/doc/index.rst renamed to showcases/tsn/trafficshaping/tokenbucketshaper/doc/index.rst.todo

File renamed without changes.

showcases/wireless/directionalantennas/doc/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,6 @@ By default, the cross-section plane is perpendicular to the current
8686
viewing angle (however, one can specify other
8787
planes in the antenna's local coordinate system).
8888

89-
For a more in-depth overview of antenna lobe visualization, read the :ref:`corresponding section <ug:sec:visualization:radio-state>`
90-
in the INET User's Guide.
9189
For the description of all parameters of the visualizer, check the NED documentation
9290
of :ned:`RadioVisualizerBase`.
9391

tutorials/ospf/omnetpp.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -762,3 +762,4 @@ extends = Step1
762762
*.R4.pcapRecorder[0].pcapNetwork = 1 # ethernet
763763
*.R4.pcapRecorder[0].pcapFile = "results/R4.eth0.pcap"
764764

765+
# ---------------------------------------------------------------

0 commit comments

Comments
 (0)