From b4684c3d7c5226464c5842f06034fff3d1fde257 Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Sun, 5 Feb 2023 09:00:09 -0800 Subject: [PATCH] doc: Fix spelling and capitalization errors --- doc/tutorial/source/building-topologies.rst | 4 ++-- doc/tutorial/source/conceptual-overview.rst | 4 ++-- doc/tutorial/source/getting-started.rst | 8 ++++---- doc/tutorial/source/tracing.rst | 6 +++--- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/tutorial/source/building-topologies.rst b/doc/tutorial/source/building-topologies.rst index 435a56d8b..d67fa726c 100644 --- a/doc/tutorial/source/building-topologies.rst +++ b/doc/tutorial/source/building-topologies.rst @@ -970,7 +970,7 @@ helpers: YansWifiPhyHelper phy = YansWifiPhyHelper::Default(); For simplicity, this code uses the default PHY layer configuration and -channel models which are documented in the API doxygen documentation for +channel models which are documented in the API Doxygen documentation for the ``YansWifiChannelHelper::Default`` and ``YansWifiPhyHelper::Default`` methods. Once these objects are created, we create a channel object and associate it to our PHY layer object manager to make sure @@ -1524,7 +1524,7 @@ At the device layer, there are device specific queues: packets) for QoS stations * SimpleNetDevice: The default configuration is to install a DropTail queue of default size (100 packets) -* LTENetDevice: Queueing occurs at the RLC layer (RLC UM default buffer is 10 * 1024 bytes, RLC AM does not have a buffer limit). +* LteNetDevice: Queueing occurs at the RLC layer (RLC UM default buffer is 10 * 1024 bytes, RLC AM does not have a buffer limit). * UanNetDevice: There is a default 10 packet queue at the MAC layer diff --git a/doc/tutorial/source/conceptual-overview.rst b/doc/tutorial/source/conceptual-overview.rst index e55960937..a4d28ad62 100644 --- a/doc/tutorial/source/conceptual-overview.rst +++ b/doc/tutorial/source/conceptual-overview.rst @@ -125,7 +125,7 @@ versions of the ``NetDevice`` called ``CsmaNetDevice``, Just as an Ethernet NIC is designed to work with an Ethernet network, the ``CsmaNetDevice`` is designed to work with a ``CsmaChannel``; the ``PointToPointNetDevice`` is designed to work with a -``PointToPointChannel`` and a ``WifiNetNevice`` is designed to work with +``PointToPointChannel`` and a ``WifiNetDevice`` is designed to work with a ``WifiChannel``. Topology Helpers @@ -605,7 +605,7 @@ Similar to many other helper objects, the ``UdpEchoServerHelper`` object has an ``Install`` method. It is the execution of this method that actually causes the underlying echo server application to be instantiated and attached to a node. Interestingly, the ``Install`` method takes a -``NodeContainter`` as a parameter just as the other ``Install`` methods +``NodeContainer`` as a parameter just as the other ``Install`` methods we have seen. This is actually what is passed to the method even though it doesn't look so in this case. There is a C++ *implicit conversion* at work here that takes the result of ``nodes.Get(1)`` (which returns a smart diff --git a/doc/tutorial/source/getting-started.rst b/doc/tutorial/source/getting-started.rst index 2bbb46ba1..28d520a3e 100644 --- a/doc/tutorial/source/getting-started.rst +++ b/doc/tutorial/source/getting-started.rst @@ -199,7 +199,7 @@ Downloading ns-3 Using Bake The above two techniques (source archive, or ns-3-allinone repository via Git) are useful to get the most basic installation of |ns3| with a few addons (pybindgen for generating Python bindings, and netanim -for network animiations). The third repository provided by default in +for network animations). The third repository provided by default in ns-3-allinone is called ``bake``. Bake is a tool for coordinated software building from multiple repositories, @@ -735,7 +735,7 @@ that a compiler warning will cause the build to fail. For instance, ns-3.28 was released prior to Fedora 28, which included a new major version of gcc (gcc-8). Building ns-3.28 or older releases -on Fedora 28, when Gtk2+ is installed, will result in an error such as:: +on Fedora 28, when GTK+2 is installed, will result in an error such as:: /usr/include/gtk-2.0/gtk/gtkfilechooserbutton.h:59:8: error: unnecessary parentheses in declaration of ‘__gtk_reserved1’ [-Werror=parentheses] void (*__gtk_reserved1); @@ -1081,11 +1081,11 @@ Note: the command above would fail if ``./ns3 build`` was not executed first, since the examples won't be built by the test-runner target. On Windows, the Msys2/MinGW64/bin directory path must be on the PATH environment variable, -otherwise the dll's required by the C++ runtime will not be found, resulting in crashes +otherwise the DLL's required by the C++ runtime will not be found, resulting in crashes without any explicit reasoning. Note: The ns-3 script adds only the ns-3 lib directory path to the PATH, -ensuring the ns-3 dlls will be found by running programs. If you are using CMake directly or +ensuring the ns-3 DLLs will be found by running programs. If you are using CMake directly or an IDE, make sure to also include the path to ns-3-dev/build/lib in the PATH variable. .. _setx : https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/setx/ diff --git a/doc/tutorial/source/tracing.rst b/doc/tutorial/source/tracing.rst index a1a349e86..2bcaf89b7 100644 --- a/doc/tutorial/source/tracing.rst +++ b/doc/tutorial/source/tracing.rst @@ -3,7 +3,7 @@ .. role:: raw-role(raw) :format: html latex -.. Mimic doxygen formatting for parameter names +.. Mimic Doxygen formatting for parameter names .. raw:: html @@ -596,7 +596,7 @@ to the eighth Node in the list of nodes created during the simulation As described in the Object Model section of the |ns3| Manual, we make widespread use of object aggregation. This allows us to form an association between different Objects without building a complicated -inheritance tree or predeciding what objects will be part of a +inheritance tree or pre-deciding what objects will be part of a Node. Each Object in an Aggregation can be reached from the other Objects. @@ -1566,7 +1566,7 @@ node in a simulation, a pointer to that Node is added to the global Take a look at ``src/network/model/node-list.cc`` and search for ``NodeList::Add``. The public static implementation calls into a private implementation called ``NodeListPriv::Add``. This is a -relatively common idom in |ns3|. So, take a look at +relatively common idiom in |ns3|. So, take a look at ``NodeListPriv::Add``. There you will find, ::