docs: fix numerous references and formatting issues
Change-Id: I2be0a3a49e1dd11a74324d925b1c9f7fcde7f29b
diff --git a/AUTHORS.rst b/AUTHORS.rst
index f0114a4..bf9a28f 100644
--- a/AUTHORS.rst
+++ b/AUTHORS.rst
@@ -30,8 +30,8 @@
Technical Advisors
------------------
-* Lan Wang <http://www.cs.memphis.edu/~lanwang>
-* Beichuan Zhang <http://cs.arizona.edu/~bzhang>
+* Lan Wang <https://www.cs.memphis.edu/~lanwang/>
+* Beichuan Zhang <https://www2.cs.arizona.edu/~bzhang/>
The Mini-CCNx team
diff --git a/docs/conf.py b/docs/conf.py
index 45fb6f2..271a19d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,7 +1,6 @@
# Configuration file for the Sphinx documentation builder.
#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
+# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
@@ -17,21 +16,28 @@
from minindn import __version__
# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'Mini-NDN'
copyright = '2015-{}, Mini-NDN. This research is partially supported by NSF.'.format(datetime.now().year)
author = 'Mini-NDN'
-# The full version, including alpha/beta/rc tags
-release = __version__
+# The short X.Y version.
version = __version__
+# The full version, including alpha/beta/rc tags.
+release = __version__
+
+
# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
+ 'sphinx.ext.extlinks',
+ 'sphinx.ext.todo',
]
# Add any paths that contain templates here, relative to this directory.
@@ -44,6 +50,7 @@
# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
@@ -59,3 +66,10 @@
# https://github.com/readthedocs/readthedocs.org/issues/2569
# https://stackoverflow.com/questions/56336234/build-fail-sphinx-error-contents-rst-not-found
master_doc = 'index'
+
+
+# -- Misc options ------------------------------------------------------------
+
+extlinks = {
+ 'issue': ('https://redmine.named-data.net/issues/%s', 'issue #%s'),
+}
diff --git a/docs/experiment.rst b/docs/experiment.rst
index 0cc2ae6..aa2692d 100644
--- a/docs/experiment.rst
+++ b/docs/experiment.rst
@@ -6,12 +6,12 @@
Mini-NDN uses a configuration file describing the topology and its parameters to setup a network.
-The [nodes] section:
+**The [nodes] section**
-At the bare minimum, the node section describes the nodes present in the
-topology.
+At the bare minimum, the ``nodes`` section describes the nodes present in the
+topology, e.g.:
-::
+.. code-block:: cfg
[nodes]
a: key1=value1 key2=value2
@@ -19,36 +19,35 @@
Any key and value passed here is accessible in Mini-NDN as:
-::
+.. code-block:: python
ndn = Minindn(...)
- value = ndn.net.hosts[0].params['params'].get('key1', "defaultValue")
+ value = ndn.net.hosts[0].params['params'].get('key1', 'defaultValue')
One can specify log levels for each node's NFD and NLSR using this key-value system:
-::
+.. code-block:: cfg
[nodes]
a: nfd-log-level=DEBUG nlsr-log-level=DEBUG
b: nfd-log-level=INFO
-To specify a log level for certain modules of NFD, the following line can be added to `nfd.py`:
+To specify a log level for certain modules of NFD, the following line can be added to ``nfd.py``:
-::
+.. code-block:: python
node.cmd('infoedit -f {} -s log.Forwarder -v {}'.format(self.confFile, 'INFO'))
-This will turn on FORWARDER logging to INFO for all nodes.
+This will turn on Forwarder logging to INFO for all nodes.
-.. Todo: Add switch section
+.. todo::
+ Document [switches] section
-The [links] section:
+**The [links] section**
-The links section describes the links in the topology.
+The ``links`` section describes the links in the topology, e.g.:
-::
-
- e.g.)
+.. code-block:: cfg
[links]
a:b delay=10ms
@@ -56,16 +55,16 @@
This would create a link between a and b. 'b:a' would also result in the
same. The following parameters can be configured for a node:
-- delay : Delay parameter is a required parameter which defines the
+- ``delay`` : Delay parameter is a required parameter which defines the
delay of the link (1-1000ms)
-- bw : Bandwidth of a link (<1-1000> Mbps)
+- ``bw`` : Bandwidth of a link (<1-1000> Mbps)
-- loss : Percentage of packet loss (<1-100>)
+- ``loss`` : Percentage of packet loss (<1-100>)
-Example configuration file
+Example configuration file:
-::
+.. code-block:: cfg
[nodes]
a:
@@ -73,14 +72,14 @@
[links]
a:b delay=10ms bw=100
-See ``ndn_utils/topologies`` for more sample files
+See the ``topologies`` folder for more sample files.
-Sample
-------
+Example
+-------
Sample experiment may written as follows:
-.. code:: python
+.. code-block:: python
from mininet.log import setLogLevel, info
@@ -128,30 +127,31 @@
in the ``minindn/apps`` folder. Or users may choose to directly run their application on nodes
such as ndnpingserver is run in ``minindn/helpers/experiment.py``.
-**Note:** A certain log-level can be set-up for all the NFD or NLSR nodes at once by passing it as an argument during the startup.
+**Note:** A certain log level can be configured for all the NFD or NLSR nodes at once by passing it as an argument during startup, e.g.:
-``nfds = AppManager(self.ndn, self.ndn.net.hosts, Nfd, logLevel='DEBUG')`` (same for NLSR)
+.. code-block:: python
+
+ nfds = AppManager(self.ndn, self.ndn.net.hosts, Nfd, logLevel='DEBUG')
Execution
---------
-To run Mini-NDN with the default topology,
-``ndn_utils/topologies/default-topology.conf``, type:
+To run Mini-NDN with the default topology, ``topologies/default-topology.conf``, type:
-::
+.. code-block:: sh
sudo python examples/minindn.py
To run Mini-NDN with a topology file, provide the filename as the first
argument:
-::
+.. code-block:: sh
sudo python examples/minindn.py my-topology.conf
After Mini-NDN is installed, users can run examples from anywhere with python directly as follows:
-::
+.. code-block:: sh
sudo python /path/to/myexample.py
@@ -163,59 +163,63 @@
During set up, the list of nodes in the network will be listed as they
are initialized:
-::
+.. code-block:: none
*** Adding hosts:
a b c d
After set up, the command-line interface (CLI) will display a prompt.
-::
+.. code-block:: none
mini-ndn>
To interact with a node, first type the node's name and then the command
to be executed:
-::
+.. code-block:: sh
mini-ndn> a echo "Hello, world!"
Hello, world!
To see the status of the forwarder on the node:
-::
+.. code-block:: sh
mini-ndn> a nfdc status report
To see the status of routing on the node:
-::
+.. code-block:: sh
mini-ndn> a nlsrc status
-To exit Mini-NDN, type ``quit`` in the CLI or use ``ctrl + D``:
+To exit Mini-NDN, type ``quit`` in the CLI or use :kbd:`Ctrl-d`:
-::
+.. code-block:: sh
mini-ndn> quit
-``Ctrl + C`` is used to quit an application run in the foreground of the command line.
+:kbd:`Ctrl-c` is used to quit an application run in the foreground of the command line.
For a more in depth explanation of the CLI, please see the `Mininet
-Walkthrough <http://mininet.org/walkthrough/>`__.
+Walkthrough <https://mininet.org/walkthrough/>`__.
To run NDN commands from the outside the command line user can also open a new terminal
-and export the HOME folder of a node ``export HOME=/tmp/minindn/a && cd ~``
+and export the HOME folder of a node:
+
+.. code-block:: sh
+
+ export HOME=/tmp/minindn/a && cd ~
Working Directory Structure
---------------------------
-Currently Mini-NDN uses /tmp/minindn as the working directory if not
-specified otherwise by using the option --work-dir.
+Currently Mini-NDN uses ``/tmp/minindn`` as the working directory if not
+specified otherwise by using the option ``--work-dir``.
-Each node is given a HOME directory under /tmp/minindn/<node-name> where
-<node-name> is the name of the node specified in the [nodes] section of
+Each node is given a HOME directory under ``/tmp/minindn/<node-name>`` where
+``<node-name>`` is the name of the node specified in the ``[nodes]`` section of
the conf file.
NFD
@@ -256,11 +260,13 @@
Link State Routing (NLSR)
_________________________
-By default, Mini-NDN uses `NLSR <https://github.com/named-data/NLSR>`__ for route management i.e route computation, route installation and so on. Additionally, the command line utility ``nlsrc`` can be used to advertise and withdraw prefixes and route status.
+By default, Mini-NDN uses `NLSR <https://github.com/named-data/NLSR>`__ for route management, i.e., route computation, route installation, etc.
+Additionally, the command-line utility ``nlsrc`` can be used to advertise and withdraw prefixes and route status.
NDN Routing Helper
-____________________
+__________________
+
Computes link-state or hyperbolic route/s from a given minindn topology and installs them in the FIB. The major benefit of the routing helper is to eliminate the overhead of NLSR when using larger topology. See ``examples/static_routing_experiment.py`` on how to use the helper class.
**IMPORTANT:** NLSR and NDN Routing Helper are mutually exclusive, meaning you can only use one at a time, not both.
diff --git a/docs/howtos.rst b/docs/howtos.rst
index 4cc50a6..ce98c1d 100644
--- a/docs/howtos.rst
+++ b/docs/howtos.rst
@@ -2,26 +2,26 @@
======
Connect Mini-NDN nodes to an outside network
----------------------------------------------
+--------------------------------------------
Mini-NDN nodes can be connected to an outside network indirectly by
running NFD on the local machine:
-::
+.. code-block:: none
(Mini-NDN node) ------ (NFD running on the host machine where Mini-NDN is running) ------- (External Network)
Add a node in root namespace
____________________________
-For this simple example, we can use a single node topology with node 'a'
+For this simple example, we can use a single node topology with node 'a'.
If we want node 'a' to connect to the host machine, we need to add a
"root" node which has a link with node "a."
Then the following code can be used:
-.. code:: python
+.. code-block:: python
topo = Topo()
root = topo.addHost('root', inNamespace=False)
@@ -29,17 +29,16 @@
topo.addLink(root, a, delay='10ms')
ndn = Minindn(topo=topo)
-
...
Configuration
_____________
-Run Mini-NDN with the above code and issue ifconfig on the local
+Run Mini-NDN with the above code and issue ``ifconfig`` on the local
machine to confirm the addition of the interface. You should be able to
locate "root-eth0":
-::
+.. code-block:: none
root-eth0 Link encap:Ethernet HWaddr 3e:eb:77:d2:6f:1f
inet addr:1.0.0.9 Bcast:1.0.0.11 Mask:255.255.255.252
@@ -51,9 +50,9 @@
RX bytes:2667 (2.6 KB) TX bytes:2797 (2.7 KB)
To make the IP address associated with this interface persistent, add
-the following line to /etc/network/interfaces and reboot your machine:
+the following line to ``/etc/network/interfaces`` and reboot your machine:
-::
+.. code-block:: none
iface root-eth0 inet manual
@@ -62,15 +61,15 @@
After rebooting, run Mini-NDN and issue the following command:
-::
+.. code-block:: none
mini-ndn>net
a a-eth0:b-eth0 a-eth1:c-eth0 a-eth2:root-eth0
-Node "a" is connected to "root-eth0". Now issue "ifconfig a-eth2" on
+Node "a" is connected to "root-eth0". Now issue ``ifconfig a-eth2`` on
node "a":
-::
+.. code-block:: none
mini-ndn>a ifconfig a-eth2
a-eth2 Link encap:Ethernet HWaddr fa:76:d4:86:d3:ba
@@ -79,7 +78,7 @@
As learned from the previous step, the IP address of root-eth0 is
1.0.0.9.
-::
+.. code-block:: none
mini-ndn>a ping 1.0.0.9
PING 1.0.0.9 (1.0.0.9) 56(84) bytes of data.
@@ -88,7 +87,7 @@
The host machine will also be able to ping node "a":
-::
+.. code-block:: none
VirtualBox:~$ ping 1.0.0.10
PING 1.0.0.10 (1.0.0.10) 56(84) bytes of data.
@@ -99,15 +98,15 @@
Start NFD on the local machine by using:
-::
+.. code-block:: sh
sudo nfd
-The "nfd-start" script cannot be used, since the script allows only one
+The ``nfd-start`` script cannot be used, since the script allows only one
instance of NFD at a time. The NFD processes running on the Mini-NDN
-nodes will prevent the "nfd-start" script from working.
+nodes will prevent the ``nfd-start`` script from working.
-Now, using "nfdc register", we can register a route from node "a" in
+Now, using ``nfdc register``, we can register a route from node "a" in
Mini-NDN to the NFD process on the host machine and from the host
machine to an external machine.
@@ -115,11 +114,11 @@
reached via external machines.
Generate NDN testbed topology
-___________________________________________
+_____________________________
-Visit the `NDN Play testbed <https://play.ndn.today/?testbed=1>`_
-page and utilize the `MiniNDN Config` button after setting loss
+Visit the `NDN Play testbed <https://play.ndn.today/?testbed=1>`__
+page and utilize the "MiniNDN Config" button after setting loss
and latency parameters. This will export an up to date topology
modeled on the testbed. We also provide a topology at
-`topologies/testbed.conf`, which is based on a sample from 2020
-which has latencies based on measurements from that configuration.
\ No newline at end of file
+``topologies/testbed.conf``, which is based on a sample from 2020
+which has latencies based on measurements from that configuration.
diff --git a/docs/install.rst b/docs/install.rst
index 5557d1c..29f92b2 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -18,7 +18,9 @@
------------
You can use the latest image from `GitHub Container Registry
-<https://github.com/named-data/mini-ndn/pkgs/container/mini-ndn>`__::
+<https://github.com/named-data/mini-ndn/pkgs/container/mini-ndn>`__:
+
+.. code-block:: sh
docker run -it --cpus=4 --memory=4g --privileged \
-v /lib/modules:/lib/modules \
@@ -29,11 +31,15 @@
The provided Dockerfile can be used to build an image from scratch. To build with the Dockerfile:
- - Clone the repository and type::
+- Clone the repository and type:
+
+ .. code-block:: sh
docker build -t minindn .
- - You can then access the container through shell with::
+- You can then access the container through shell with:
+
+ .. code-block:: sh
docker run -it --cpus=4 --memory=4g --privileged \
-v /lib/modules:/lib/modules \
@@ -73,7 +79,7 @@
To install Mini-NDN and its dependencies, clone this repository and run:
-::
+.. code-block:: sh
./install.sh
@@ -94,7 +100,7 @@
You can see all command line flags by running:
-::
+.. code-block:: sh
./install.sh -h
@@ -118,20 +124,20 @@
Mini-NDN is based on Mininet. To install Mininet:
-::
+.. code-block:: sh
git clone --depth 1 https://github.com/mininet/mininet.git
After Mininet source is on your system, run the following command to
install Mininet core dependencies and Open vSwitch:
-::
+.. code-block:: sh
./util/install.sh -nv
To check if Mininet is working correctly, run this test:
-::
+.. code-block:: sh
sudo mn --test pingall
@@ -185,7 +191,7 @@
Infoedit is used to edit configuration files for NFD and NLSR.
To install infoedit:
-::
+.. code-block:: sh
git clone --depth 1 https://github.com/NDN-Routing/infoedit
cd infoedit
@@ -198,7 +204,7 @@
You can execute the following example to bring up the Mini-NDN command line
with NFD and NLSR running on each node:
-::
+.. code-block:: sh
sudo python examples/mnndn.py
@@ -224,17 +230,16 @@
You can install the most recent release using:
-::
+.. code-block:: sh
./install.sh --source --release=current
You can also select a specified release using:
-::
+.. code-block:: sh
./install.sh --source --release=[chosen version]
-
Currently, the compatible versions include:
- ``2024-08``: ndn-cxx 0.9.0, NFD 24.07, NLSR 24.08, PSync 0.5.0,
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index b012c2b..fcc66eb 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -8,47 +8,47 @@
- Install behavior regarding existing installation of dependencies has been reversed; by default, these are now ignored. This is meant
to clear up confusion regarding installing on existing installs which have been used for NDN development previously. The previous
- behavior can be enabled using `--use-existing`.
+ behavior can be enabled using ``--use-existing``.
**New features**:
-- Added `NFDCBatch` to NFDC helper, which allows the user to use the existing NFDC wrapper API to instead create and execute a batch file.
- When running large numbers of commands, this significantly speeds up performance due to not needing to add delay between individual CLI
- calls.
-- Added `MinindnAdhoc` class which can be used to construct adhoc Mini-NDN-Wifi networks from topology files.
+- Added ``NFDCBatch`` to NFDC helper, which allows the user to use the existing NFDC wrapper API to instead create and execute a batch file.
+ When running large numbers of commands, this significantly speeds up performance due to not needing to add delay between individual CLI calls.
+- Added ``MinindnAdhoc`` class which can be used to construct adhoc Mini-NDN-Wifi networks from topology files.
- Model mobility parameters can now also be passed to Mini-NDN-Wifi via topology files.
-- Working directory can be passed as constructor argument to `Minindn` objects
-- We have added a new `--release` flag to the installer which simplifies installing matching releases of dependencies. Reference
- `the install documentation <./install.rst>`__ for more information.
-- Experimental wifi support for NLSR helper. See `experiment docs <experiment>` for details (`issue: 5232 <https://redmine.named-data.net/issues/5232>`__)
+- Working directory can be passed as constructor argument to ``Minindn`` objects.
+- We have added a new ``--release`` flag to the installer which simplifies installing matching releases of dependencies.
+ Reference the :doc:`install documentation <install>` for more information.
+- Experimental WiFi support for NLSR helper.
+ See the :doc:`experiment docs <experiment>` for details (`issue: 5232 <https://redmine.named-data.net/issues/5232>`__)
- Added a Dockerfile for Mini-NDN. A prebuilt image for *linux/amd64* platforms is available on the
- `GitHub container registry <https://github.com/named-data/mini-ndn/pkgs/container/mini-ndn>`__
-- The previous testbed topology generation script has been deprecated and removed. Please reference the `NDN Play website <https://play.ndn.today/?testbed=1>`__
- for a replacement
+ `GitHub container registry <https://github.com/named-data/mini-ndn/pkgs/container/mini-ndn>`__.
+- The previous testbed topology generation script has been deprecated and removed.
+ Please reference the `NDN Play website <https://play.ndn.today/?testbed=1>`__ for a replacement.
**Improvements**:
- Ethernet unicast faces are now supported natively by NLSR wrapper, NFDC wrapper, and NDN routing helper. No additional formatting by the user is needed
for ethernet addresses extracted from the Mininet API when passed to these functions (`issue: 5321 <https://redmine.named-data.net/issues/5232>`__)
-- `NdnRoutingHelper` has been parallelized along with minor optimizations. You can now also use it to create
+- ``NdnRoutingHelper`` has been parallelized along with minor optimizations. You can now also use it to create
permanent faces (`issue: 5264 <https://redmine.named-data.net/issues/5264>`__)
-- `checkConvergence` method of `Experiment` helper can now output more detailed information when flag `returnConvergenceInfo` is set
+- ``checkConvergence`` method of ``Experiment`` helper can now output more detailed information when flag ``returnConvergenceInfo`` is set
(`issue: 5236 <https://redmine.named-data.net/issues/5236>`__)
-- `getPopen` can now accept commands formatted as lists as well as strings
-- We now natively edit nfd.conf files using infoconv to read and write it as json rather than calling infoedit at the shell
+- ``getPopen`` can now accept commands formatted as lists as well as strings
+- We now natively edit ``nfd.conf`` files using infoconv to read and write it as json rather than calling infoedit at the shell
(`issue: 5318 <https://redmine.named-data.net/issues/5318>`__)
- Added Sprint PoP topology
-- Link bandwidth value (`bw`) can now be specified as decimal megabits rather than only integers in topology files
-- NFDC was significantly refactored for the `NFDCBatch` change.
+- Link bandwidth value (``bw``) can now be specified as decimal megabits rather than only integers in topology files
+- NFDC was significantly refactored for the ``NFDCBatch`` change.
**Bug fixes**:
- NFDC helper properly supports existing faces and no longer outputs unnecessary error messages if face exists by default.
- Fixed out of date ndnsec commands
-- Socket path now defaults to NFD default as of release 24.07. You can specify a different path with the `defaultSocketLocation`
- argument in the `Nfd` object constructor (`issue: 5309 <https://redmine.named-data.net/issues/5309>`__)
+- Socket path now defaults to NFD default as of release 24.07. You can specify a different path with the ``defaultSocketLocation``
+ argument in the ``Nfd`` object constructor (`issue: 5309 <https://redmine.named-data.net/issues/5309>`__)
- Fixed jitter being parsed into incorrect type from topology files
-- Moved vestigial CLI arguments relating to `wifi_ping.py` example out of the Mini-NDN-Wifi class
+- Moved vestigial CLI arguments relating to ``wifi_ping.py`` example out of the Mini-NDN-Wifi class
Mini-NDN version 0.6.0 (Major changes since version 0.5.0)
@@ -61,7 +61,7 @@
- Set dependency versions: PPA, git repository & commit
- Separate download and build+install steps
- Don't reinstall package if it's already installed
- - More details `here <https://github.com/named-data/mini-ndn/blob/master/docs/install.rst>`__
+ - More details :doc:`here <install>`
- `Note: <https://redmine.named-data.net/issues/5161>`__ We have dropped support for python 2, the latest Mini-NDN requires at least python 3.0
@@ -84,13 +84,13 @@
- Support running NDN applications on mixed topologies (`issue: 5160 <https://redmine.named-data.net/issues/5160>`__)
-- Support route addition using face-id in `Nfdc` helper (`issue: 5130 <https://redmine.named-data.net/issues/5130>`__)
+- Support route addition using face-id in ``Nfdc`` helper (`issue: 5130 <https://redmine.named-data.net/issues/5130>`__)
-- Add wrapper for `ndnpingserver` and fix passing the Mininet host object as a prefix on ndnpingclient
+- Add wrapper for ndnpingserver and fix passing the Mininet host object as a prefix on ndnpingclient
-- Show status of route calculation in `NdnRoutingHelper`
+- Show status of route calculation in ``NdnRoutingHelper``
-- Incorporate changes of `NDNPing` Class (wrapper of pingserver and pingclient) in the examples
+- Incorporate changes of ``NDNPing`` Class (wrapper of pingserver and pingclient) in the examples
- Support simple topology files with no additional parameters
@@ -120,7 +120,7 @@
**Improvements and Bug Fixes**:
-- Change workDir and resultDir to be class attribute
+- Change ``workDir`` and ``resultDir`` to be class attribute
- Quiet apt install for Vagrant
@@ -128,7 +128,7 @@
- Fix overwriting of existing prefixes in ``ndn_routing_helper``
-- Move log files to resultDir after evaluation finishes
+- Move log files to ``resultDir`` after evaluation finishes
- Check for duplicate HR coordinates in the topology file
@@ -162,7 +162,7 @@
- Use Infoedit to edit NFD and NLSR configuration files
-- Use nlsr.conf installed in the system
+- Use ``nlsr.conf`` installed in the system
- Provide a Vagrantfile to setup Mini-NDN and NDN
@@ -170,7 +170,7 @@
- Provide an option to run NLSR in dry-run mode
-- Add option to specify whether to use TCP or UDP face in nlsr.conf
+- Add option to specify whether to use TCP or UDP face in ``nlsr.conf``
- Add option to specify arbitrary arguments to use in experiments
@@ -192,7 +192,7 @@
- Update to latest ndn-cxx
-- Use /tmp/minindn folder as default work dir instead of /tmp
+- Use ``/tmp/minindn`` folder as default work dir instead of ``/tmp``
Mini-NDN version 0.3.0 (changes since version 0.2.0)
----------------------------------------------------
@@ -215,7 +215,7 @@
**Misc changes**:
-- Removed nlsr.conf file, generate it within the code
+- Removed ``nlsr.conf`` file, generate it within the code
- Use argparse instead of deprecated optparse
@@ -225,15 +225,15 @@
- Set network name at one place
-- Update install.sh script to install openssl
+- Update ``install.sh`` script to install openssl
-- Update install.sh script to install cryptopp from package instead of
+- Update ``install.sh`` script to install cryptopp from package instead of
compiling from source
-- Update install.sh to clean build folder every time to get rid of
+- Update ``install.sh`` to clean build folder every time to get rid of
removed files such as old experiments
-- Fix old code - use net.hosts instead of storing hosts in a variable
+- Fix old code - use ``net.hosts`` instead of storing hosts in a variable
- Use nfdc instead of deprecated nfd-status
@@ -246,16 +246,15 @@
- Automatic security configuration for NLSR
-- Use /usr/local/etc/ndn/nfd.conf as default config file for NFD
+- Use ``/usr/local/etc/ndn/nfd.conf`` as default config file for NFD
-- Class to monitor /proc/$PID/stat file for PID
+- Class to monitor ``/proc/$PID/stat`` file for PID
- Mini-NDN exits gracefully on SIGINT and non-convergence
-- Faster Mini-NDN install script - does not do apt-get update everytime
+- Faster Mini-NDN install script - does not do ``apt-get update`` every time
-- NLSR is launched with explicit config file for easier process
- identification
+- NLSR is launched with explicit config file for easier process identification
- Add and update more documentation
@@ -272,13 +271,11 @@
**New features**:
-- Use nfd.conf.sample from currently installed NFD
+- Use ``nfd.conf.sample`` from currently installed NFD
-- Add working directory option to allow execution environment outside
- of /tmp
+- Add working directory option to allow execution environment outside of ``/tmp``
-- Add results directory option to store experiment results after
- completion
+- Add results directory option to store experiment results after completion
- Add support for switches in GUI and configuration file
@@ -308,7 +305,7 @@
Mini-NDN is a lightweight networking emulation tool that enables
testing, experimentation, and research on the NDN platform. Based on
Mininet, Mini-NDN uses the NDN libraries, NFD, NLSR, and tools released
-by the `NDN project <http://named-data.net/codebase/platform/>`__ to
+by the `NDN project <https://named-data.net/codebase/platform/>`__ to
emulate an NDN network on a single system.
**Included features**: