docs: fix syntax highlighting of code blocks

And various other cleanups Change-Id: I240badc5358c09f006c2a22d4706ce373f2dd188
2020-10-07 13:18:44 -04:00
1 parent 0bba81df36
commit 9f6a7d97bc
@@ -59,22 +59,18 @@ The ``ether`` configuration file section contains settings for Ethernet faces an
 channels. These settings will **NOT** work without root or without setting the
 appropriate permissions.

-**Ubuntu:**
-
-::
+- On **Ubuntu**::

    sudo apt install libcap2-bin
    sudo setcap cap_net_raw,cap_net_admin=eip /path/to/nfd

-**macOS:**
-
-::
+- On **macOS**::

    curl https://bugs.wireshark.org/bugzilla/attachment.cgi?id=3373 -o ChmodBPF.tar.gz
    tar zxvf ChmodBPF.tar.gz
    open ChmodBPF/Install\ ChmodBPF.app

-or manually::
+  or manually::

    sudo chgrp admin /dev/bpf*
    sudo chmod g+rw /dev/bpf*
@@ -75,7 +75,7 @@ The first step is to obtain the source code for NFD and its main dependency, the
 *ndn-cxx* library. If you do not want a development version of NFD, make sure you
 checkout the correct release tag (e.g., ``*-0.7.0``) from both repositories.

-::
+.. code-block:: sh

    # Download ndn-cxx
    git clone https://github.com/named-data/ndn-cxx.git
@@ -97,11 +97,15 @@ and its prerequisites.

 On Linux, NFD needs the following dependencies to enable optional features:

- On Ubuntu::
+- On **Ubuntu**:
+
+  .. code-block:: sh

    sudo apt install libpcap-dev libsystemd-dev

- On CentOS and Fedora::
+- On **CentOS** and **Fedora**:
+
+  .. code-block:: sh

    sudo dnf config-manager --enable PowerTools  # on CentOS only
    sudo dnf install libpcap-devel systemd-devel
@@ -109,7 +113,9 @@ On Linux, NFD needs the following dependencies to enable optional features:
 Build
 ~~~~~

-The following commands can be used to build and install NFD from source::
+The following commands can be used to build and install NFD from source:
+
+.. code-block:: sh

    ./waf configure  # on CentOS, add --without-pch
    ./waf
@@ -117,7 +123,9 @@ The following commands can be used to build and install NFD from source::

 If you have installed ndn-cxx and/or any other dependencies into a non-standard path,
 you may need to modify the ``PKG_CONFIG_PATH`` environment variable before running
-``./waf configure``. For example::
+``./waf configure``. For example:
+
+.. code-block:: sh

    export PKG_CONFIG_PATH="/custom/lib/pkgconfig:$PKG_CONFIG_PATH"
    ./waf configure
@@ -141,7 +149,7 @@ If this is not desired, the default flags can be overridden to disable debug sym
 The following example shows how to completely disable debug symbols and configure
 NFD to be installed into ``/usr`` with configuration in the ``/etc`` directory.

-::
+.. code-block:: sh

    CXXFLAGS="-O2" ./waf configure --prefix=/usr --sysconfdir=/etc
    ./waf
@@ -154,14 +162,18 @@ Customizing the compiler

 To build NFD with a different compiler (rather than the platform default), set the
 ``CXX`` environment variable to point to the compiler binary. For example, to build
-with clang on Linux, use the following::
+with clang on Linux, use the following:
+
+.. code-block:: sh

    CXX=clang++ ./waf configure

 Building the documentation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~

-Tutorials and API documentation can be built using the following commands::
+Tutorials and API documentation can be built using the following commands:
+
+.. code-block:: sh

    # Full set of documentation (tutorials + API) in build/docs
    ./waf docs
@@ -1,10 +1,8 @@
-# -*- coding: utf-8 -*-
-#
 # 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:
-# http://www.sphinx-doc.org/en/master/config
+# https://www.sphinx-doc.org/en/master/usage/configuration.html

 # -- Path setup --------------------------------------------------------------

@@ -23,10 +21,10 @@ project = u'Named Data Networking Forwarding Daemon (NFD)'
 copyright = u'Copyright © 2014-2020 Named Data Networking Project.'
 author = u'Named Data Networking Project'

-# The short X.Y version
+# The short X.Y version.
 #version = ''

-# The full version, including alpha/beta/rc tags
+# The full version, including alpha/beta/rc tags.
 #release = ''

 # There are two options for replacing |today|: either, you set today to some
@@ -40,7 +38,7 @@ today_fmt = '%Y-%m-%d'

 # If your documentation needs a minimal Sphinx version, state it here.
 #
-needs_sphinx = '1.1'
+needs_sphinx = '1.3'

 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -87,6 +85,9 @@ html_theme_path = ['.']
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']

+# Disable syntax highlighting of code blocks by default.
+highlight_language = 'none'
+

 # -- Options for LaTeX output ------------------------------------------------

@@ -2129,12 +2129,6 @@ EXTERNAL_GROUPS        = YES

 EXTERNAL_PAGES         = YES

-# The PERL_PATH should be the absolute path and name of the perl script
-# interpreter (i.e. the result of 'which perl').
-# The default file (with absolute path) is: /usr/bin/perl.
-
-PERL_PATH              = /usr/bin/perl
-
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
@@ -2148,15 +2142,6 @@ PERL_PATH              = /usr/bin/perl

 CLASS_DIAGRAMS         = YES

-# You can define message sequence charts within doxygen comments using the \msc
-# command. Doxygen will then run the mscgen tool (see:
-# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
-# documentation. The MSCGEN_PATH tag allows you to specify the directory where
-# the mscgen tool resides. If left empty the tool is assumed to be found in the
-# default search path.
-
-MSCGEN_PATH            =
-
 # You can include diagrams made with dia in doxygen documentation. Doxygen will
 # then run dia to produce the diagram and insert it in the documentation. The
 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
@@ -1,9 +1,9 @@
-NFD - Named Data Networking Forwarding Daemon
-=============================================
+NFD: Named Data Networking Forwarding Daemon
+============================================

-NFD is a network forwarder that implements and evolves together with the Named Data
-Networking (NDN) `protocol <https://named-data.net/doc/ndn-tlv/>`__. NFD is a core
-component of the `NDN Platform <https://named-data.net/codebase/platform/>`__.
+**NFD** is a network forwarder that implements and evolves together with the Named Data
+Networking (NDN) `protocol <https://named-data.net/doc/NDN-packet-spec/current/>`__.
+NFD is a core component of the `NDN Platform <https://named-data.net/codebase/platform/>`__.

 NFD Documentation
 -----------------
@@ -38,7 +38,8 @@ NFD Documentation

 * :doc:`manpages`

-**Additional documentation**
+Additional Documentation
+^^^^^^^^^^^^^^^^^^^^^^^^

 * `NFD Developer's Guide <https://named-data.net/publications/techreports/ndn-0021-10-nfd-developer-guide/>`__

@@ -50,12 +51,12 @@ NFD Documentation

 * `NFD Wiki <https://redmine.named-data.net/projects/nfd/wiki>`__

-  + `NFD Management protocol <https://redmine.named-data.net/projects/nfd/wiki/Management>`__
-  + `NFD Configuration file format <https://redmine.named-data.net/projects/nfd/wiki/ConfigFileFormat>`__
-
  The NFD Wiki contains detailed protocol specifications and
  information for building on unsupported platforms.

+  + `NFD Management protocol <https://redmine.named-data.net/projects/nfd/wiki/Management>`__
+  + `NFD configuration file format <https://redmine.named-data.net/projects/nfd/wiki/ConfigFileFormat>`__
+
 * `API Documentation (doxygen) <doxygen/annotated.html>`__

 * :doc:`RELEASE_NOTES`
@@ -3,30 +3,25 @@
 Local hub prefix discovery
 ==========================

-Some applications need to discover the prefix(es) under which they can publish data
-/ which Interests the local hub will be able to forward down to the application.
-In order to discover that, applications need to send an Interest for
-``/localhop/nfd/rib/routable-prefixes`` prefix. Response data to the
-Interest contains a list of prefixes and should be encoded as follows:
+Some applications need to discover the prefix(es) under which they can publish
+data / which Interests the local hub will be able to forward down to the
+application. In order to discover that, an application can send an Interest for
+``/localhop/nfd/rib/routable-prefixes``. The data in response to this Interest
+will contain a list of prefixes and should be encoded as follows:

-::
+.. code-block:: abnf

-    Response ::= DATA-TYPE TLV-LENGTH
-                   Name (= /localhop/nfd/rib/routable-prefixes/[version]/[segment])
-                   MetaInfo (= ResponseMetaInfo)
-                   Content (= ResponseContent)
-                   Signature
+    Response = DATA-TYPE TLV-LENGTH
+                 Name     ; /localhop/nfd/rib/routable-prefixes/[version]/[segment]
+                 MetaInfo ; ContentType == BLOB, FreshnessPeriod == 5000
+                 ResponseContent
+                 DataSignature

-    ResponseMetaInfo ::= META-INFO-TYPE TLV-LENGTH
-                           ContentType (= BLOB)
-                           FreshnessPeriod (= 5000)
+    ResponseContent = 1*Name

-    ResponseContent ::= Name+
-
-.. note::
-    ResponseContent should contain at least one ``Name``, which should be routable
-    towards the face from which the request has been received.  The requester may
-    process the list of returned names and pick whichever it wants to use.
+``ResponseContent`` should contain at least one ``Name``, which should be routable
+towards the face from which the request was received.  The requester may process
+the list of returned names and pick whichever it wants to use.

 For now, the ``/localhop/nfd/rib/routable-prefixes`` data is served by
 :ref:`ndn-autoconfig-server`.
@@ -3,12 +3,10 @@
 ndn-autoconfig-server
 =====================

-Usage
-----
+Synopsis
+--------

-::
-
-    ndn-autoconfig-server [-h] [-p <PREFIX>] [-p <PREFIX>] ... <FACEURI>
+**ndn-autoconfig-server** [**-h**] [**-V**] [**-p** *PREFIX*]... *FACEURI*

 Description
 -----------
@@ -3,12 +3,10 @@
 ndn-autoconfig
 ==============

-Usage
-----
+Synopsis
+--------

-::
-
-    ndn-autoconfig [options]
+**ndn-autoconfig** [**-h**] [**-V**] [**-c** *file*] [**-d**]

 Description
 -----------
@@ -24,11 +22,11 @@ Options

  NOTE: if connection to NFD fails, the daemon will be terminated.

-``-c [FILE]`` or ``--config=[FILE]``
+``-c FILE`` or ``--config=FILE``
  Use the specified configuration file. If `enabled = true` is not specified in the
  configuration file, no actions will be performed.

-``--ndn-fch-url=[URL]``
+``--ndn-fch-url=URL``
  Use the specified URL to find the closest hub (NDN-FCH protocol).  If not specified,
  ``http://ndn-fch.named-data.net/`` will be used.  Only ``http://`` URLs are supported.

@@ -1,12 +1,10 @@
 nfd-autoreg
 ===========

-Usage
-----
+Synopsis
+--------

-::
-
-    nfd-autoreg --prefix=</autoreg/prefix> [--prefix=</another/prefix>] ...
+**nfd-autoreg** --prefix=</autoreg/prefix> [--prefix=</another/prefix>]...

 Description
 -----------
@@ -1,12 +1,10 @@
 nfd-status-http-server
 ======================

-Usage
-----
+Synopsis
+--------

-::
-
-    nfd-status-http-server [-h] [-p <PORT>] [-a <IPADDR>] [-r] [-v]
+**nfd-status-http-server** [**-h**] [**-a** *IPADDR*] [**-p** *PORT*] [**-r**] [**-v**]

 Description
 -----------
@@ -17,14 +15,14 @@ Options
 -------

 ``-h``
-  Show this help message and exit.
-
-``-p <PORT>``
-  HTTP server port number (default is 8080).
+  Show help message and exit.

 ``-a <IPADDR>``
  HTTP server IP address (default is 127.0.0.1).

+``-p <PORT>``
+  HTTP server port number (default is 8080).
+
 ``-r``
  Enable HTTP robots to crawl (disabled by default).

@@ -1,12 +1,10 @@
 nfd
 ===

-Usage
-----
+Synopsis
+--------

-::
-
-    nfd [options]
+**nfd** [**-h**] [**-V**] [**-c** *file*] [**-m**]

 Description
 -----------
@@ -2,10 +2,9 @@ NFD Overview
 ============

 NDN Forwarding Daemon (NFD) is a network forwarder that implements and evolves together
-with the Named Data Networking (NDN) `protocol
-<https://named-data.net/doc/ndn-tlv/>`__. After the initial release, NFD will become a core
-component of the `NDN Platform <https://named-data.net/codebase/platform/>`__ and will
-follow the same release cycle.
+with the Named Data Networking (NDN) `protocol <https://named-data.net/doc/NDN-packet-spec/current/>`__.
+Since the initial public release in 2014, NFD has been a core component of the
+`NDN Platform <https://named-data.net/codebase/platform/>`__.

 NFD is developed by a community effort. Although the first release was mostly done by the
 members of `NSF-sponsored NDN project team
@@ -25,7 +24,7 @@ performance.  The intention is that performance optimizations are one type of ex
 that developers can conduct by trying out different data structures and different
 algorithms; over time, better implementations may emerge within the same design framework.
 To facilitate such experimentation with the forwarder, the NFD team has also written a
-`developer's guide <https://named-data.net/wp-content/uploads/2016/10/ndn-0021-7-nfd-developer-guide.pdf>`_,
+`developer's guide <https://named-data.net/publications/techreports/ndn-0021-10-nfd-developer-guide/>`__,
 which details the current implementation and provides tips for extending all aspects of
 NFD.

@@ -7,8 +7,8 @@ This is an incomplete list of features that are implemented in NFD version 0.1.0

 - **Packet Format**

-  + `NDN-TLV <http://named-data.net/doc/ndn-tlv/>`_
-  + LocalControlHeader, to allow apps to set outgoing face and learn incoming face.
+  + `NDN-TLV <https://named-data.net/doc/NDN-packet-spec/0.1/>`__
+  + LocalControlHeader, to allow apps to set outgoing face and learn incoming face

 - **Faces**

@@ -21,8 +21,7 @@ This is an incomplete list of features that are implemented in NFD version 0.1.0
    .. note::
         Ethernet support will not work properly on Linux kernels with TPACKET_V3 flexible
         buffer implementation (>= 3.2.0) and libpcap >= 1.5.0 (e.g., Ubuntu Linux 14.04).
-         Refer to `Issue 1551 <http://redmine.named-data.net/issues/1511>`_ for more
-         detail and implementation progress.
+         Refer to :issue:`1551` for more details and implementation progress.

 - **Management**

@@ -64,7 +63,6 @@ This is an incomplete list of features that are implemented in NFD version 0.1.0
  + ``nfd-status``, a command-line tool to query NFD status.
  + ``nfd-status-http-server``, which reads the NFD status and publishes over HTTP.

-
 Planned Functions and Features for Next Releases
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

@@ -7,8 +7,8 @@ Changes since version 0.1.0:

 - **Documentation**

-  + `"NFD Developer's Guide" by NFD authors
-    <http://named-data.net/wp-content/uploads/2014/07/NFD-developer-guide.pdf>`_ that
+  + `"NFD Developer's Guide" by the NFD authors
+    <https://named-data.net/wp-content/uploads/2019/05/ndn-0023-2-nfd-developer-guide.pdf>`_ that
    explains NFD's internals including the overall design, major modules, their
    implementation, and their interactions

@@ -29,9 +29,9 @@ Changes since version 0.1.0:

 - **Faces**

-  + `WebSocket <http://tools.ietf.org/html/rfc6455>`_ Face support (:issue:`1468`)
+  + `WebSocket <https://tools.ietf.org/html/rfc6455>`_ Face support (:issue:`1468`)

-  + Fix Ethernet Face support on Linux with ``libpcap`` version >=1.5.0 (:issue:`1511`)
+  + Fix Ethernet Face support on Linux with ``libpcap`` version >= 1.5.0 (:issue:`1511`)

  + Fix to recognize IPv4-mapped IPv6 addresses in ``FaceUri`` (:issue:`1635`)

@@ -5,8 +5,8 @@ Release date: February 2, 2015

 Changes since version 0.2.0:

-New features:
-^^^^^^^^^^^^^
+New features
+^^^^^^^^^^^^

 - **Build**

@@ -89,11 +89,11 @@ New features:

 - **Core**

-  + New scheduler::ScopedEventId class to automatically handle scheduled event lifetime
+  + New ``scheduler::ScopedEventId`` class to automatically handle scheduled event lifetime
    (:issue:`2295`)

-Updates and bug fixes:
-^^^^^^^^^^^^^^^^^^^^^^
+Improvements and bug fixes
+^^^^^^^^^^^^^^^^^^^^^^^^^^

 - **Documentation**

@@ -107,23 +107,23 @@ Updates and bug fixes:

  + Use implementations moved to ndn-cxx library

-     + Use Signal from ndn-cxx (:issue:`2272`, :issue:`2300`)
+     + Use ``Signal`` from ndn-cxx (:issue:`2272`, :issue:`2300`)

-     + use ethernet::Address from ndn-cxx (:issue:`2142`)
+     + use ``ethernet::Address`` from ndn-cxx (:issue:`2142`)

     + Use MAX_NDN_PACKET_SIZE constant from ndn-cxx (:issue:`2099`)

     + Use DEFAULT_INTEREST_LIFETIME from ndn-cxx (:issue:`2202`)

-     + Use FaceUri from ndn-cxx (:issue:`2143`)
+     + Use ``FaceUri`` from ndn-cxx (:issue:`2143`)

-     + Use DummyClientFace from ndn-cxx (:issue:`2186`)
+     + Use ``DummyClientFace`` from ndn-cxx (:issue:`2186`)

-     + Use ndn::dns from ndn-cxx (:issue:`2207`)
+     + Use ``ndn::dns`` from ndn-cxx (:issue:`2207`)

-  + Move Network class implementation from ``tools/`` to ``core/``
+  + Move ``Network`` class implementation from ``tools/`` to ``core/``

-  + Ignore non-Ethernet ``AF_LINK`` addresses when enumerating NICs on OSX and other BSD systems
+  + Ignore non-Ethernet ``AF_LINK`` addresses when enumerating NICs on OS X and other BSD systems

  + Fix bug on not properly setting FreshnessPeriod inside SegmentPublisher (:issue:`2438`)

@@ -217,9 +217,10 @@ Updates and bug fixes:
  + Ensure that ``ndn-autoconfig`` canonizes FaceUri before sending commands to NFD
    (:issue:`2387`)

-  + Refactored ndn-autoconfig implementation (:issue:`2421`)
+  + Refactored ``ndn-autoconfig`` implementation (:issue:`2421`)

-  + ndn-autoconfig will now register also ``/localhop/nfd`` prefix towards the hub (:issue:`2416`)
+  + ``ndn-autoconfig`` will now register also ``/localhop/nfd`` prefix towards the hub
+    (:issue:`2416`)

 - **Tests**

@@ -5,8 +5,8 @@ Release date: March 3, 2015

 Changes since version 0.3.0:

-New features:
-^^^^^^^^^^^^^
+New features
+^^^^^^^^^^^^

 - ``nfd`` and ``nrd`` daemons are now merged into a single process using separate threads
  (:issue:`2489`)
@@ -32,16 +32,16 @@ New features:

  - ContentStore now recognizes CachingPolicy-NoCache from LocalControlHeader (:issue:`2185`)

-Updates and bug fixes:
-^^^^^^^^^^^^^^^^^^^^^^
+Improvements and bug fixes
+^^^^^^^^^^^^^^^^^^^^^^^^^^

 - **Faces**

-  - Remove Tcp|UdpChannel::connect overloads that perform DNS resolution (:issue:`2422`)
+  - Remove ``Tcp|UdpChannel::connect`` overloads that perform DNS resolution (:issue:`2422`)

-  - Properly handle error conditions in UdpChannel::newPeer (:issue:`2516`)
+  - Properly handle error conditions in ``UdpChannel::newPeer`` (:issue:`2516`)

-  - Fix inconsistency of UDP face timeouts in sample `nfd.conf` and actual defaults
+  - Fix inconsistency between UDP face timeouts in sample ``nfd.conf`` and actual defaults
    (:issue:`2473`)

  - Introduce Face-specific logging macros (:issue:`2450`)
@@ -5,8 +5,8 @@ Release date: May 12, 2015

 Changes since version 0.3.1:

-New features:
-^^^^^^^^^^^^^
+New features
+^^^^^^^^^^^^

 - **Tables**

@@ -16,8 +16,8 @@ New features:

  * Perform FIB updates before modifying RIB (:issue:`1941`)

-Updates and bug fixes:
-^^^^^^^^^^^^^^^^^^^^^^
+Improvements and bug fixes
+^^^^^^^^^^^^^^^^^^^^^^^^^^

 - **Documentation**

@@ -30,7 +30,7 @@ Updates and bug fixes:

  * Refactor channel acceptors to avoid use of shared pointers (:issue:`2613`)

-  * Refactor code to avoid deprecated `Block::fromBuffer` overloads (:issue:`2553`)
+  * Refactor code to avoid deprecated ``Block::fromBuffer`` overloads (:issue:`2553`)

  * Refactor code to use move semantics for sockets where possible (:issue:`2613`)

@@ -48,7 +48,7 @@ Updates and bug fixes:

 - **Tools**

-  * Fix hanging of `nfdc` on wrong input (:issue:`2690`)
+  * Fix hanging of ``nfdc`` on wrong input (:issue:`2690`)

 - **Build**

@@ -62,7 +62,7 @@ Updates and bug fixes:

  * Use C version of snprintf (:issue:`2299`)

-  * Emulate `std::to_string` when it is missing (:issue:`2299`)
+  * Emulate ``std::to_string`` when it is missing (:issue:`2299`)

  * Fix several "defined but not used" warnings with gcc-5 (:issue:`2767`)

@@ -5,14 +5,14 @@ Release date: July 1, 2015

 Changes since version 0.3.2:

-New features:
-^^^^^^^^^^^^^
+New features
+^^^^^^^^^^^^

 - Content Store replacement policy interface (:issue:`1207`)

 - Add unit file and instructions for systemd (:issue:`1586`)

- NDN Essential Tools version 0.1 `<https://github.com/named-data/ndn-tools>`__ featuring:
+- NDN Essential Tools version 0.1 (https://github.com/named-data/ndn-tools) featuring:

  * ``ndnpeek``, ``ndnpoke``: a pair of programs to request and make available for retrieval of
    a single Data packet
@@ -22,23 +22,23 @@ New features:
    either an input file or the standard input, and displays the Type-Length-Value (TLV)
    structure of those packets on the standard output.

-Updates and bug fixes:
-^^^^^^^^^^^^^^^^^^^^^^
+Improvements and bug fixes
+^^^^^^^^^^^^^^^^^^^^^^^^^^

 - Avoid loopback new Interest in AccessStrategy (:issue:`2831`)

 - Simplified implementation of ``nfd-status`` using SegmentFetcher utility class (:issue:`2456`)

-Deprecated:
-^^^^^^^^^^^
+Deprecations
+^^^^^^^^^^^^

 - ``ndn-tlv-peek`` and ``ndn-tlv-poke`` command-line tools: use ``ndnpeek`` and ``ndnpoke``
-  programs from NDN Essential Tools repository `<https://github.com/named-data/ndn-tools>`__.
+  programs from the `NDN Essential Tools repository <https://github.com/named-data/ndn-tools>`__.

-Upcoming features:
-^^^^^^^^^^^^^^^^^^
+Upcoming features
+^^^^^^^^^^^^^^^^^

- NDNLPv2 (http://redmine.named-data.net/projects/nfd/wiki/NDNLPv2, :issue:`2520`,
+- `NDNLPv2 <https://redmine.named-data.net/projects/nfd/wiki/NDNLPv2>`__ (:issue:`2520`,
  :issue:`2879`, :issue:`2763`, :issue:`2883`, :issue:`2841`, :issue:`2866`)

 - Refactored implementation of NFD management (:issue:`2200`, :issue:`2107`)
@@ -5,10 +5,10 @@ Release date: August 31, 2015

 Changes since version 0.3.3:

-New features:
-^^^^^^^^^^^^^
+New features
+^^^^^^^^^^^^

- Boolean Face property IsOnDemand has been replaced with multistate FacePersistency
+- The boolean Face property ``IsOnDemand`` has been replaced with multistate FacePersistency
  property (:issue:`2989`, :issue:`3018`): persistent (Face exists as long as there are no
  system or socket errors), on-demand (Face is removed after inactivity period), and
  permanent (Face exists unless explicitly destroyed by the management).
@@ -22,16 +22,8 @@ New features:
  Currently, changing the policy requires a minor change in NFD source code.
  Configuration interface is coming in the next release (:issue:`3148`)

-
-Updates and bug fixes:
-^^^^^^^^^^^^^^^^^^^^^^
-
- Update of NDN Essential Tools to version 0.2 `<https://github.com/named-data/ndn-tools>`__
-  with code improvements and the following new tools:
-
-  * PIB service to manage the public information of keys and publish certificates
-    (:issue:`3018`)
-  * A Wireshark dissector for NDN packets (:issue:`3092`)
+Improvements and bug fixes
+^^^^^^^^^^^^^^^^^^^^^^^^^^

 - RibManager constructor now accepts KeyChain as a parameter, preparing it for simplifying
  implementation with the new ``ndn::Dispatcher`` class (:issue:`2390`)
@@ -41,18 +33,18 @@ Updates and bug fixes:
 - Enable automatic re-creation of multicast faces when network connectivity changes
  (:issue:`2460`)

- Enhance exception throwing with Boost Exception library (:issue:`2541`)
+- Enhance exception throwing with the Boost Exception library (:issue:`2541`)

-Deprecated:
-^^^^^^^^^^^
+Deprecations
+^^^^^^^^^^^^

- BroadcastStrategy (``/localhost/nfd/strategy/broadcast``) renamed as MulticastStrategy
+- BroadcastStrategy (``/localhost/nfd/strategy/broadcast``) renamed to MulticastStrategy
  (``/localhost/nfd/strategy/multicast``) (:issue:`3011`)

-Upcoming features (partially finished in development branches):
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Upcoming features (partially finished in development branches)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- NDNLPv2 (http://redmine.named-data.net/projects/nfd/wiki/NDNLPv2, :issue:`2520`,
+- `NDNLPv2 <https://redmine.named-data.net/projects/nfd/wiki/NDNLPv2>`__ (:issue:`2520`,
  :issue:`2879`, :issue:`2763`, :issue:`2883`, :issue:`2841`, :issue:`2866`)

 - Refactored implementation of NFD management (:issue:`2200`, :issue:`2107`)
@@ -8,8 +8,8 @@ Release date: December 31, 2015

 Changes since version 0.3.4:

-New features:
-^^^^^^^^^^^^^
+New features
+^^^^^^^^^^^^

 - **(breaking change)** Refactored implementation of face system (:issue:`3088`, :issue:`3104`,
  :issue:`3165`, :issue:`3168`, :issue:`3225`, :issue:`3226`, :issue:`3253`, :issue:`3259`,
@@ -40,8 +40,8 @@ New features:
     LocalControlHeader features, it must be updated to use the new protocol (e.g., update
     to use ndn-cxx >= 0.4.0)

- Support for NDNLPv2 (http://redmine.named-data.net/projects/nfd/wiki/NDNLPv2,
-  :issue:`2520`, :issue:`2763`, :issue:`2841`)
+- Support for the following `NDNLPv2 <https://redmine.named-data.net/projects/nfd/wiki/NDNLPv2>`__
+  features (:issue:`2520`, :issue:`2763`, :issue:`2841`):

  * Network NACK (:issue:`2883`)
  * Fragmentation and reassembly  (:issue:`3171`)
@@ -61,8 +61,8 @@ New features:
 - Automatic start of NDN auto-configuration client (``ndn-autoconfig``) when starting NFD
  using ``nfd-start``, when enabled in ``autoconfig.conf`` (:issue:`2716`)

-Updates and bug fixes:
-^^^^^^^^^^^^^^^^^^^^^^
+Improvements and bug fixes
+^^^^^^^^^^^^^^^^^^^^^^^^^^

 - **(breaking change)** Redesign of automatic prefix propagation, formerly known as remote
  prefix registration (:issue:`3211`, :issue:`2413`)
@@ -90,8 +90,8 @@ Updates and bug fixes:
 - Multiple test suite improvements (:issue:`3322`, :issue:`3306`, :issue:`3305`, :issue:`3307`,
  :issue:`3346`, :issue:`3327`)

-Deprecated:
-^^^^^^^^^^^
+Deprecations
+^^^^^^^^^^^^

 - BroadcastStrategy (``/localhost/nfd/strategy/broadcast``) renamed as MulticastStrategy
  (``/localhost/nfd/strategy/multicast``) (:issue:`3011`)
@@ -99,13 +99,13 @@ Deprecated:
 - ForwarderStatus dataset retrievable using ``/localhost/nfd/status`` name, use
  ``/localhost/nfd/status/general`` instead.

-Deleted:
+Removals
 ^^^^^^^^

- NotificationStream, replaced by the version in ndn-cxx library (:issue:`2144`)
+- ``NotificationStream``, replaced by the version in ndn-cxx library (:issue:`2144`)

-Known issues:
-^^^^^^^^^^^^^
+Known issues
+^^^^^^^^^^^^

 - NFD currently has a known limitation in supporting the retrieval of data using full names,
  i.e., names with the implicit digest (:issue:`3363`).  This limitation will be addressed
@@ -5,8 +5,8 @@ Release date: March 25, 2016

 Changes since version 0.4.0:

-Updates and bug fixes:
-^^^^^^^^^^^^^^^^^^^^^^
+Improvements and bug fixes
+^^^^^^^^^^^^^^^^^^^^^^^^^^

 - Fix retrieval of data using full names, i.e., names with the implicit digest (:issue:`3363`)

@@ -23,9 +23,9 @@ Updates and bug fixes:
 - Remove assumption from the management test suites that data packets are always published
  in NFD's content store (:issue:`2182`)

-Deleted:
+Removals
 ^^^^^^^^

 - ``ndn-tlv-peek`` and ``ndn-tlv-poke`` command-line tools: use ``ndnpeek`` and ``ndnpoke``
-  programs from `NDN Essential Tools repository <https://github.com/named-data/ndn-tools>`__
+  programs from the `NDN Essential Tools repository <https://github.com/named-data/ndn-tools>`__
  (:issue:`2819`)
@@ -14,7 +14,7 @@ Release date: October 4, 2016
   compiled on such systems, but requires separate installation of a newer version of the compiler
   (e.g., clang-3.4) and dependencies.

-Changes since version 0.4.1
+Changes since version 0.4.1:

 New features
 ^^^^^^^^^^^^
@@ -105,8 +105,8 @@ Deprecations
 - ``StrategyInfoHost::getOrCreateStrategyInfo``, which is renamed to
  ``StrategyInfoHost::insertStrategyInfo`` (:issue:`3205`)

-Deletions
-^^^^^^^^^
+Removals
+^^^^^^^^

 - Previously deprecated BroadcastStrategy (:issue:`3206`)

@@ -3,7 +3,7 @@ NFD version 0.5.1

 Release date: January 25, 2017

-Changes since version 0.5.0
+Changes since version 0.5.0:

 New features
 ^^^^^^^^^^^^
@@ -98,8 +98,8 @@ Deprecations
  list`` and ``nfdc status report xml``. The argument-less ``nfd-status`` is retained as an
  alias of ``nfdc status report`` (:issue:`3780`)

-Deletions
-^^^^^^^^^
+Removals
+^^^^^^^^

 - Delete deprecated ``Strategy::sendInterest`` overload and ``violatesScope`` (:issue:`1756`,
  :issue:`3841`)
@@ -91,8 +91,8 @@ Bugfixes

 - Fix potential misaligned memory accesses (:issue:`4191`)

-Deletions
-^^^^^^^^^
+Removals
+^^^^^^^^

 - Deprecated code, including ``faces/enable-local-control`` and ``faces/disable-local-control``
  management commands (:issue:`3988`)
@@ -3,8 +3,8 @@ NFD version 0.6.1

 Release date: February 19, 2018

-New features:
-^^^^^^^^^^^^^
+New features
+^^^^^^^^^^^^

 - (potentially breaking change) ``nfd-status-http-server`` now requires Python 3

@@ -3,13 +3,8 @@ NFD version 0.6.2

 Release date: May 4, 2018

-Note that this is the last release that process packets with [NDN packet format version
-0.2.1](https://named-data.net/doc/NDN-packet-spec/0.2.1/) semantics. A future release will
-continue to decode v0.2.1 format, but will process packets with
-[v0.3](https://named-data.net/doc/NDN-packet-spec/0.3/) semantics.
-
-New features:
-^^^^^^^^^^^^^
+New features
+^^^^^^^^^^^^

 - ``afterContentStoreHit``, ``afterReceiveData`` strategy trigger (:issue:`4290`)

@@ -41,7 +36,7 @@ Improvements and bug fixes

 - Upgrade build environment to latest version of ``waf`` and other improvements

-Removals:
-~~~~~~~~~
+Removals
+^^^^^^^^

 - ``onInterestUnsatisfied`` pipeline stage (:issue:`4290`)
@@ -3,10 +3,10 @@ NFD version 0.6.6

 Release date: April 29, 2019

-Note that this is the last release that encodes to `NDN packet format version 0.2.1
-<https://named-data.net/doc/NDN-packet-spec/0.2.1/>`__. A future release will continue to
-decode v0.2.1 format, but will encode to `v0.3 format
-<https://named-data.net/doc/NDN-packet-spec/0.3/>`__.
+.. note::
+   This is the last release to support the `NDN packet format version 0.2.1
+   <https://named-data.net/doc/NDN-packet-spec/0.2.1/>`__. The next release will support
+   only the `v0.3 packet format <https://named-data.net/doc/NDN-packet-spec/0.3/>`__.

 New features
 ^^^^^^^^^^^^