docs: Documentation update for 0.1.0 release
Change-Id: I5d7c0f3b4242103d6ad4e864316fb50c3634f21b
diff --git a/docs/RELEASE_NOTES.rst b/docs/RELEASE_NOTES.rst
index 1f3f282..92e2a0b 100644
--- a/docs/RELEASE_NOTES.rst
+++ b/docs/RELEASE_NOTES.rst
@@ -3,62 +3,17 @@
NFD v0.1.0 Release Notes
========================
-Major Modules of NFD
---------------------
-
-NFD has the following major modules:
-
-- Core
- Provides various common services shared between different NFD modules. These include
- hash computation routines, DNS resolver, config file, face monitoring, and
- several other modules.
-
-- Faces
- Implements the NDN face abstraction on top of different lower level transport
- mechanisms.
-
-- Tables
- Implements the Content Store (CS), the Pending Interest Table (PIT), the Forwarding
- Information Base (FIB), and other data structures to support forwarding of NDN Data
- and Interest packets.
-
-- Forwarding
- Implements basic packet processing pathways, which interact with Faces, Tables,
- and Strategies.
-
- + **Strategy Support**, a major part of the forwarding module
- Implements a framework to support different forwarding strategies. It includes
- StrategyChoice, Measurements, Strategies, and hooks in the forwarding pipelines. The
- StrategyChoice records the choice of the strategy for a namespace, and Measurement
- records are used by strategies to store past performance results for namespaces.
-
-- Management
- Implements the `NFD Management Protocol
- <http://redmine.named-data.net/projects/nfd/wiki/Management>`_, which allows
- applications to configure NFD and set/query NFD's internal states. Protocol interaction
- is done via NDN's Interest/Data exchange between applications and NFD.
-
-- RIB Management
- Manages the routing information base (RIB). The RIB may be updated by different parties
- in different ways, including various routing protocols, application's prefix
- registrations, and command-line manipulation by sysadmins. The RIB management module
- processes all these requests to generate a consistent forwarding table, and then syncs
- it up with the NFD's FIB, which contains only the minimal information needed for
- forwarding decisions. Strictly speaking RIB management is part of the NFD management
- module. However, due to its importance to the overall operations and its more complex
- processing, we make it a separate module.
-
Features in Version 0.1.0
-------------------------
This is an incomplete list of features that are implemented in NFD version 0.1.0.
-- Packet Format
+- **Packet Format**
+ `NDN-TLV <http://named-data.net/doc/ndn-tlv/>`_
+ LocalControlHeader, to allow apps to set outgoing face and learn incoming face.
-- Faces
+- **Faces**
+ Unix stream socket
+ UDP unicast
@@ -72,7 +27,7 @@
Refer to `Issue 1551 <http://redmine.named-data.net/issues/1511>`_ for more
detail and implementation progress.
-- Management
+- **Management**
+ Use of signed Interests as commands, with authentication and authorization.
+ Face management
@@ -81,20 +36,20 @@
+ NFD status publishing
+ Notification to authorized apps of internal events, including Face creation and destruction.
-- Tables and forwarding pipelines support most Interest/Data processing, including
+- **Tables and forwarding pipelines** support most Interest/Data processing, including
selectors.
-- RIB Management that runs as a separate process, ``nrd``. It supports basic prefix
+- **RIB Management** that runs as a separate process, ``nrd``. It supports basic prefix
registration by applications, but no flags yet.
-- Strategies
+- **Strategies**
+ ``broadcast``
+ ``best-route``
+ ``ncc``: based on ccnx 0.7 for experimentation
+ ``client-control``: authorized application can directly control Interest forwarding
-- Name-based scoping
+- **Name-based scoping**
+ ``/localhost``: communication only within localhost using "local" Faces
(UnixStreamFace, LocalTcpFace). NFD will strictly enforce this scope for Interests
@@ -102,9 +57,9 @@
+ ``/localhop``: one-hop communication (e.g., if at least one incoming or outgoing Face
in PIT entry is non-local, the Interest cannot be forwarded to any non-local Face)
-- Support configuration file, which is in the Boost INFO format.
+- **Support configuration file**, which is in the Boost INFO format.
-- Applications
+- **Applications**
+ Tools to discover hubs on NDN testbed.
+ peek/poke and traffic generators for testing and debugging.
@@ -124,7 +79,8 @@
Additional strategies, including self-learning that populates the FIB by observing
Interest and Data exchange.
-- Hop-by-hop Interest limit mechanism for congestion control.
+- Hop-by-hop Interest limit mechanism
+ For congestion control
- Face enhancements
Add fragmentation support for Ethernet face, may add support for new types such as
@@ -140,5 +96,4 @@
For hub nodes to authenticate incoming tunnel requests and maintain the tunnels.
- Extensible name-based scoping
-
- + configurable organization-based scoping
+ Configurable organization-based scoping