docs: fix numerous references and formatting issues
Change-Id: I2be0a3a49e1dd11a74324d925b1c9f7fcde7f29b
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**: