SunnyQjm/NLSR
1
0 Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: minor documentation corrections

Browse Source 
Change-Id: I2e7b2d385f44ce894dcc2981e0fc6670df74aff1
This commit is contained in:
Junxiao Shi authored and Junxiao Shi committed 2015-01-14 09:29:55 -08:00
1 parent b45eed2d28
commit f09e2633a0
5 files changed
+22 -29
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+6 -3
View File
@@ -1,6 +1,9 @@
NLSR - Named Data Link State Routing Protocol
=============================================
For complete documentation and more extensive information,
please visit the [NLSR homepage](http://named-data.net/doc/NLSR/current/).
## Overview
NLSR is a routing protocol in NDN that populates NDN's Routing Information Base. NLSR
@@ -28,9 +31,9 @@ Source releases
The source code and source-code installation instructions are always available at
the following links:
- [Installation](https://github.com/named-data/NLSR/blob/master/docs/INSTALL.md)
- [Getting Started with NLSR](https://github.com/named-data/NLSR/blob/master/docs/GETTING-STARTED.md)
- [Github NLSR repository](https://github.com/named-data/NLSR)
- [Installation](http://named-data.net/doc/NLSR/current/INSTALL.html)
- [Getting Started with NLSR](http://named-data.net/doc/NLSR/current/GETTING-STARTED.html)
- [GitHub NLSR repository](https://github.com/named-data/NLSR)
Additional information
----------------------
docs/RELEASE-NOTES.rst
+8 -17
View File
@@ -13,30 +13,21 @@ prefix in a single authoritative domain.
**Included features**:
- Produce a list of ranked forwarding options for each name prefix to facilitate NDN's adaptive forwarding strategies
- Name Prefix advertisement
+ Advertise availability of content through the configured router
- Advertise availability of content through the configured router
- Use `ChronoSync <https://github.com/named-data/ChronoSync>`_ to synchronize routers' LSA sequence numbers and Interest/Data to retrieve LSAs
- Limit faces per prefix
- Produce a list of ranked forwarding options for each name prefix to facilitate NDN's adaptive forwarding strategies
+ Configure maximum number of faces per prefix in NFD's RIB
- Configure maximum number of faces per prefix in NFD’s RIB
- Automatic NFD tunnel configuration and maintenance to neighbors
- Set up NFD tunnels to neighbors automatically and maintain the tunnels to neighbors
- Routing protocol
- Provide two routing protocols:
+ Link State routing
+ Hyperbolic routing
+ Calculates route cost based on a node's polar coordinates
+ Link State routing: calculate route cost based on link costs
+ Hyperbolic routing: calculate route cost based on hyperbolic coordinates
- Use a hierarchical trust model for routing within a single administrative domain
- NFD Routing Information Base (RIB) consistency
+ Provides shortest path next hops for efficient forwarding
+ Keeps NFD's RIB updated on node failure and recovery
- Keep NFD’s RIB updated on failure and recovery
docs/ROUTER-CONFIG.rst
+5 -6
View File
@@ -51,12 +51,11 @@ If you see ``ERROR: error while connecting to the forwarder (No such file or dir
Step 2. Determining FaceUri
---------------------------
Assume that ``/ndn/edu/arizona/%C1.Router/router3`` has hostname ``router3.arizona.edu``,
``/ndn/edu/colostate/%C1.Router/router2`` has IP address ``79.123.10.145``, and that all
routers in the network have agreed to sync data with name prefix ``/ndn/nlsr/sync``.
Assume that ``/ndn/edu/arizona/%C1.Router/router3`` has hostname ``router3.arizona.edu`` and
``/ndn/edu/colostate/%C1.Router/router2`` has IP address ``79.123.10.145``.
``/ndn/edu/memphis/%C1.Router/router1`` will consider FaceUri
``udp4://router3.arizona.edu`` for router ``/ndn/edu/arizona/%C1.Router/router3`` and face
uri ``udp4://79.123.10.145`` for router ``/ndn/edu/colostate/%C1.Router/router2``.
``udp4://router3.arizona.edu`` for router ``/ndn/edu/arizona/%C1.Router/router3`` and
FaceUri ``udp4://79.123.10.145`` for router ``/ndn/edu/colostate/%C1.Router/router2``.
Step 3: Creating configuration file
-----------------------------------
@@ -137,7 +136,7 @@ configuration commands follows:
; the switch is used to set hyperbolic routing calculation in NLSR
state off ; default value 'off', set value 'on' to enable hyperbolic routing table
; calculation which turns link state routing 'off'. set value to 'dry-run"
; calculation which turns link state routing 'off'. set value to 'dry-run'
; to test hyperbolic routing and compare with link state routing.
docs/index.rst
+2 -2
View File
@@ -19,7 +19,7 @@ The main design goal of NLSR is to provide a routing protocol to populate NDN's
calculates the routing table using link-state or hyperbolic routing and produces multiple
faces for each reachable name prefix in a single authoritative domain. NLSR will continue
to evolve over time to include neighbor discovery and to become a full fledged
inter-domain routing protocol for NDN. The project design is presented in full detail in
inter-domain routing protocol for NDN. The protocol design is presented in full detail in
the `NLSR Paper`_.
NLSR Documentation
@@ -58,4 +58,4 @@ Additional information
.. _NLSR Wiki: http://redmine.named-data.net/projects/nlsr
.. _NLSR Paper: http://conferences.sigcomm.org/sigcomm/2013/papers/icn/p15.pdf
.. _NLSR Paper: http://www.cs.memphis.edu/~lanwang/paper/nlsr-final.pdf
nlsr.conf
+1 -1
View File
@@ -96,7 +96,7 @@ hyperbolic
; the switch is used to set hyperbolic routing calculation in NLSR
state off ; default value 'off', set value 'on' to enable hyperbolic routing table
; calculation which turns link state routing 'off'. set value to 'dry-run"
; calculation which turns link state routing 'off'. set value to 'dry-run'
; to test hyperbolic routing and compare with link state routing.