From 9e955bcec7a51ec0455ca4daeea3e4b69fafb3ea Mon Sep 17 00:00:00 2001 From: Ashlesh Gawande Date: Thu, 30 Nov 2017 17:33:03 -0600 Subject: [PATCH] docs: Prepare version 0.4.0 release notes Split the long release notes similar to NFD Change-Id: If5ce5247bf74a4e402a33d92a35a686e7193dea1 --- AUTHORS.md | 2 +- README.md | 7 - docs/RELEASE-NOTES.rst | 244 +------------------ docs/conf.py | 7 +- docs/index.rst | 4 +- docs/named_data_theme/named_data_header.html | 2 +- docs/release-notes-latest.rst | 1 + docs/release-notes/release-notes-0.1.0.rst | 30 +++ docs/release-notes/release-notes-0.2.0.rst | 94 +++++++ docs/release-notes/release-notes-0.2.1.rst | 20 ++ docs/release-notes/release-notes-0.2.2.rst | 8 + docs/release-notes/release-notes-0.3.0.rst | 26 ++ docs/release-notes/release-notes-0.3.1.rst | 34 +++ docs/release-notes/release-notes-0.3.2.rst | 20 ++ docs/release-notes/release-notes-0.4.0.rst | 79 ++++++ docs/releases.rst | 63 +++++ wscript | 2 +- 17 files changed, 388 insertions(+), 255 deletions(-) create mode 120000 docs/release-notes-latest.rst create mode 100644 docs/release-notes/release-notes-0.1.0.rst create mode 100644 docs/release-notes/release-notes-0.2.0.rst create mode 100644 docs/release-notes/release-notes-0.2.1.rst create mode 100644 docs/release-notes/release-notes-0.2.2.rst create mode 100644 docs/release-notes/release-notes-0.3.0.rst create mode 100644 docs/release-notes/release-notes-0.3.1.rst create mode 100644 docs/release-notes/release-notes-0.3.2.rst create mode 100644 docs/release-notes/release-notes-0.4.0.rst create mode 100644 docs/releases.rst diff --git a/AUTHORS.md b/AUTHORS.md index 98b7927..2fab7dd 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -1,5 +1,5 @@ NLSR Authors -=========== +============ NLSR is an open source project includes contributions from the members of the [NDN project team](http://named-data.net/project/participants/). diff --git a/README.md b/README.md index 5c32332..9e4abac 100644 --- a/README.md +++ b/README.md @@ -35,13 +35,6 @@ the following links: - [Getting Started with NLSR](http://named-data.net/doc/NLSR/current/GETTING-STARTED.html) - [GitHub NLSR repository](https://github.com/named-data/NLSR) -Currently, NLSR is not using the latest version of the ndn-cxx library. Therefore, it is -necessary to checkout the following versions of its dependencies: - -- ndn-cxx: b555b00c280b9c9ed46f24a1fbebc73b720601af -- NFD: f4056d0242536f85b7d7b4de1b5ac50dad65c233 -- Chronosync: 097bb448f46b8bd9a5c1f431e824f8f6a169b650 - Additional information ---------------------- diff --git a/docs/RELEASE-NOTES.rst b/docs/RELEASE-NOTES.rst index ba62392..2a63dae 100644 --- a/docs/RELEASE-NOTES.rst +++ b/docs/RELEASE-NOTES.rst @@ -1,242 +1,4 @@ -Release Notes -============= +NLSR Release Notes +================== -NLSR version 0.3.2 (changes since version 0.3.1) -++++++++++++++++++++++++++++++++++++++++++++++++ - -Release date: March 15, 2017 - -**Changes** - -- NLSR constructor now accept a KeyChain argument. (:issue:`3742`) - -- Fix security rule for /localhop LSA prefix (:issue:`3899`) - -- Use ndn::nfd::ROUTE_ORIGIN_NLSR instead of a magic number. (:issue:`3903`) - -- Handle "Face Already Exists" error (error code 409) in NFD. (:issue:`3976`) - -- Enable NLSR to register localhost prefix with dispatcher before top-level prefix. (:issue:`3938`) - -- Don't use ndn aliases provided by ndn-cxx/common.hpp. (:issue:`3983`) - -- Remove use of deprecated code. (:issue:`3988`) - -NLSR version 0.3.1 (changes since version 0.3.0) -++++++++++++++++++++++++++++++++++++++++++++++++ - -Release date: January 22, 2017 - -**Changes** - -- **breaking change** Sync uses /localhop component in prefix to reduce duplicate NACKs (:issue:`3627`) - -- **breaking change** LSA uses /localhop component in prefix to reduce duplicate NACKs (:issue:`3899`) - -**Code Changes**: - -- Fib and FaceMap use std::map instead of std::list (:issue:`2781`) - -- NamePrefixTableEntries store RoutingTableEntries using a pointer (:issue:`2863`) - -- Namespace closing comments are now consistent with ndn-cxx guidelines (:issue:`3735`) - -- Update copyright date across all files (:issue:`3736`, `3909`, `3923`) - -- Improve formatting of FaceMap and FaceMapEntry (:issue:`3737`) - -- Sort NextHops on NexthopList insertion (:issue:`2721`) - -**Bug fixes**: - -- HR now recalculates paths after status change of a neighbor (:issue:`3874`) - -- NLSR no longer sets strategies multiple times (:issue:`3743`) - -- NLSR should enable use of ndn-cxx dispatcher (:issue:`3930`) - -- Fix typos in the sample configuration file (:issue:`3113`) - -NLSR version 0.3.0 (changes since version 0.2.2) -++++++++++++++++++++++++++++++++++++++++++++++++ - -Release date: August 1, 2016 - -**Code changes**: - -- Updated validation checker for LSA rule in the configuration file (:issue:`2965`) - -- Do not advertise Adjacency LSAs when hyperbolic routing is enabled (:issue:`2402`) - -- Do not distribute coordinate LSAs when using link-state routing. (:issue:`3661`) - -- LSAs should be segmented before they are published (:issue:`2965`) - -- Don't use DummyClientFace::sentDatas (:issue:`3383`) - -- Remove disabled security files (:issue:`2960`) - -- Lsa type should be argument for base class LSA constructor (:issue:`2788`) - -- Use ndn-cxx/DummyClientFace (:issue:`2637`) - -**Bug fixes**: - -- Unit tests cases are installed with `./waf install` (:issue:`3359`) - - -NLSR version 0.2.2 (changes since version 0.2.1) -++++++++++++++++++++++++++++++++++++++++++++++++ - -Release date: January 5, 2016 - -**Code changes**: - -- Adapt code to changes in NFD/ndn-cxx version 0.4.0 release - -NLSR version 0.2.1 (changes since version 0.2.0) -++++++++++++++++++++++++++++++++++++++++++++++++ - -Release date: June 30, 2015 - -**Code changes**: - -- Using a configuration file without ``prefix-update-validator`` disables runtime advertise/withdraw instead of exiting (:issue:`2814`) - -**Bug fixes**: - -- Prevent incomplete removal of NPT entry (:issue:`2785`) - -- Correct bidirectional links with differing costs (:issue:`2801`) - -- Fix non-incrementing Adjacency number in AdjLsa::writeLog (:issue:`2594`) - -- Remove FaceDestroyEvent test's reliance on nlsrSeqNo.txt (:issue:`2881`) - -- Test ACTIVE/INACTIVE Adjacencies in LSA construction (:issue:`2735`) - -NLSR version 0.2.0 (changes since version 0.1.0) -++++++++++++++++++++++++++++++++++++++++++++++++ - -Release date: April 30, 2015 - -**Build**: - -- The code now requires C++11. The minimum supported gcc version is 4.6, as earlier versions do not have proper support for C++11 features. (:issue:`1930`) - -- Require OpenSSL (:issue:`2375`) - -**New features**: - -- Add nlsrc command-line tool (:issue:`1834`) - -- Advertise/Withdraw name prefixes at runtime (:issue:`1834`) - -- Assign zero cost to hyperbolic direct neighbors (:issue:`1975`) - -- Only hyperbolic costs are adjusted before registering (:issue:`1974`) - -- Add ability to specify different logging levels (:issue:`1935`) - -- Add LSDB dataset publishers (:issue:`2280`) - -- Add LSDB dataset tlv abstractions (:issue:`2280`) - -- Allow zero cost neighbors for hyperbolic routing table calculation (:issue:`1982`) - -- Faces are now created with canonical Face URI (:issue:`1911`) - -- Add configurable router event intervals (:issue:`2071`) - -- Add router-dead-interval configuration setting (:issue:`1878`) - -- Add log formatting specified by log4cxx configuration file (:issue:`1950`) - -- Face URIs in configuration file are checked for validity on load (:issue:`2070`) - -- Configuration variables with default values are now optional (:issue:`1949`) - -- Recalculate routing table after face destroy event (:issue:`2635`) - -- Add Travis-CI build script - -**Code changes**: - -- Change adjacency status from uint32_t to enum (:issue:`1946`) - -- Remove scheduler from NLSR class (:issue:`1981`) - -- Change hyperbolic cost adjustment factor from 100 to 1000 (:issue:`1974`) - -- Remove use of outdated namespace ``ndn::Tlv`` (:issue:`2079`) - -- Remove use of deprecated ``ndn::nfd::Controller(Face&)`` constructor (:issue:`2133`) - -- Routing update publishing is abstracted to SyncLogicHandler (:issue:`2289`) - -- Make ConfParameter variable types consistent with min and max values (:issue:`2084`) - -- Replace LSA string literals with constants (:issue:`2310`) - -- Subscribe to FaceMonitor notifications using connect (:issue:`2350`) - -- Log exceptions thrown in event loop - -- Change ``ndn::ptr_lib::shared_ptr`` to ``std::shared_ptr`` (:issue:`2110`) - -- Avoid deprecated ``ndn::Name::set`` method (:issue:`2505`) - -- Update waf to version 1.8.8-dev - -- Add sorting tiebreaker to NexthopList (:issue:`2715`) - -- Update Jenkins-CI build scripts - -**Bug fixes**: - -- Fix python3 build error (:issue:`1956`) - -- Fix typos in nlsr.conf security section (:issue:`1985`) - -- Stop SyncLogicHandler from fetching a router’s own LSAs (:issue:`2005`) - -- Fix Name LSA comparison which could cause incorrect advertised names to be removed (:issue:`2029`) - -- Fix issue where more faces than max-faces-per-prefix could be applied to a prefix (:issue:`2018`) - -- Stop LSDB from retrieving and out of date LSA when a new one is detected (:issue:`1987`) - -- Correct mistakes in documentation - -- Correct bitmask used to copy Name LSA sequence number (:issue:`2323`) - -NLSR version 0.1.0 (initial release) -++++++++++++++++++++++++++++++++++++ - -Release date: August 25, 2014 - -The main design goal of NLSR is to provide a routing protocol to populate `NFD's -`_ RIB. NLSR calculates the routing table using -link-state or hyperbolic routing and produces multiple faces for each reachable name -prefix in a single authoritative domain. - -**Included features**: - -- Advertise availability of content through the configured router - -- Use `ChronoSync `_ to synchronize routers' LSA sequence numbers and Interest/Data to retrieve LSAs - -- 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 - -- Set up NFD tunnels to neighbors automatically and maintain the tunnels to neighbors - -- Provide two routing protocols: - - + 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 - -- Keep NFD’s RIB updated on failure and recovery +.. include:: release-notes-latest.rst \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index a02e3c8..d8f4b7e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,6 +12,7 @@ # All configuration values have a default; values that are commented out # serve to show the default. +import datetime import sys import os @@ -30,7 +31,7 @@ sys.path.insert(0, os.path.abspath('.')) # ones. extensions = [ 'sphinx.ext.todo', - 'redmine_issue', + 'redmine_issue' ] def addExtensionIfExists(extension): @@ -60,7 +61,7 @@ master_doc = 'index' # General information about the project. project = u'NLSR - Named Data Link State Routing Protocol' -copyright = u'2014-2015, Named Data Networking Project' +copyright = u'2014-{}, Named Data Networking Project'.format(datetime.date.today().year) # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -251,4 +252,4 @@ if os.getenv('GOOGLE_ANALYTICS', None): googleanalytics_id = os.environ['GOOGLE_ANALYTICS'] googleanalytics_enabled = True -redmine_project_url = "http://redmine.named-data.net/" +redmine_project_url = "https://redmine.named-data.net/" diff --git a/docs/index.rst b/docs/index.rst index c4059c2..c141cc4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,11 +29,12 @@ NLSR Documentation :hidden: :maxdepth: 3 - RELEASE-NOTES GETTING-STARTED INSTALL ROUTER-CONFIG SECURITY-CONFIG + RELEASE-NOTES + releases manpages - :doc:`GETTING-STARTED` @@ -41,6 +42,7 @@ NLSR Documentation - :doc:`ROUTER-CONFIG` - :doc:`SECURITY-CONFIG` - :doc:`RELEASE-NOTES` +- :doc:`releases` - :doc:`manpages` Downloading diff --git a/docs/named_data_theme/named_data_header.html b/docs/named_data_theme/named_data_header.html index 97b2932..8f3d460 100644 --- a/docs/named_data_theme/named_data_header.html +++ b/docs/named_data_theme/named_data_header.html @@ -32,7 +32,7 @@ $mathjax diff --git a/docs/release-notes-latest.rst b/docs/release-notes-latest.rst new file mode 120000 index 0000000..b54217f --- /dev/null +++ b/docs/release-notes-latest.rst @@ -0,0 +1 @@ +release-notes/release-notes-0.4.0.rst \ No newline at end of file diff --git a/docs/release-notes/release-notes-0.1.0.rst b/docs/release-notes/release-notes-0.1.0.rst new file mode 100644 index 0000000..dc492de --- /dev/null +++ b/docs/release-notes/release-notes-0.1.0.rst @@ -0,0 +1,30 @@ +NLSR version 0.1.0 (initial release) +++++++++++++++++++++++++++++++++++++ + +Release date: August 25, 2014 + +The main design goal of NLSR is to provide a routing protocol to populate `NFD's +`_ RIB. NLSR calculates the routing table using +link-state or hyperbolic routing and produces multiple faces for each reachable name +prefix in a single authoritative domain. + +**Included features**: + +- Advertise availability of content through the configured router + +- Use `ChronoSync `_ to synchronize routers' LSA sequence numbers and Interest/Data to retrieve LSAs + +- 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 + +- Set up NFD tunnels to neighbors automatically and maintain the tunnels to neighbors + +- Provide two routing protocols: + + + 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 + +- Keep NFD’s RIB updated on failure and recovery diff --git a/docs/release-notes/release-notes-0.2.0.rst b/docs/release-notes/release-notes-0.2.0.rst new file mode 100644 index 0000000..1fcf2f1 --- /dev/null +++ b/docs/release-notes/release-notes-0.2.0.rst @@ -0,0 +1,94 @@ +NLSR version 0.2.0 (changes since version 0.1.0) +++++++++++++++++++++++++++++++++++++++++++++++++ + +Release date: April 30, 2015 + +**Build**: + +- The code now requires C++11. The minimum supported gcc version is 4.6, as earlier versions do not have proper support for C++11 features. (:issue:`1930`) + +- Require OpenSSL (:issue:`2375`) + +**New features**: + +- Add nlsrc command-line tool (:issue:`1834`) + +- Advertise/Withdraw name prefixes at runtime (:issue:`1834`) + +- Assign zero cost to hyperbolic direct neighbors (:issue:`1975`) + +- Only hyperbolic costs are adjusted before registering (:issue:`1974`) + +- Add ability to specify different logging levels (:issue:`1935`) + +- Add LSDB dataset publishers (:issue:`2280`) + +- Add LSDB dataset tlv abstractions (:issue:`2280`) + +- Allow zero cost neighbors for hyperbolic routing table calculation (:issue:`1982`) + +- Faces are now created with canonical Face URI (:issue:`1911`) + +- Add configurable router event intervals (:issue:`2071`) + +- Add router-dead-interval configuration setting (:issue:`1878`) + +- Add log formatting specified by log4cxx configuration file (:issue:`1950`) + +- Face URIs in configuration file are checked for validity on load (:issue:`2070`) + +- Configuration variables with default values are now optional (:issue:`1949`) + +- Recalculate routing table after face destroy event (:issue:`2635`) + +- Add Travis-CI build script + +**Code changes**: + +- Change adjacency status from uint32_t to enum (:issue:`1946`) + +- Remove scheduler from NLSR class (:issue:`1981`) + +- Change hyperbolic cost adjustment factor from 100 to 1000 (:issue:`1974`) + +- Remove use of outdated namespace ``ndn::Tlv`` (:issue:`2079`) + +- Remove use of deprecated ``ndn::nfd::Controller(Face&)`` constructor (:issue:`2133`) + +- Routing update publishing is abstracted to SyncLogicHandler (:issue:`2289`) + +- Make ConfParameter variable types consistent with min and max values (:issue:`2084`) + +- Replace LSA string literals with constants (:issue:`2310`) + +- Subscribe to FaceMonitor notifications using connect (:issue:`2350`) + +- Log exceptions thrown in event loop + +- Change ``ndn::ptr_lib::shared_ptr`` to ``std::shared_ptr`` (:issue:`2110`) + +- Avoid deprecated ``ndn::Name::set`` method (:issue:`2505`) + +- Update waf to version 1.8.8-dev + +- Add sorting tiebreaker to NexthopList (:issue:`2715`) + +- Update Jenkins-CI build scripts + +**Bug fixes**: + +- Fix python3 build error (:issue:`1956`) + +- Fix typos in nlsr.conf security section (:issue:`1985`) + +- Stop SyncLogicHandler from fetching a router’s own LSAs (:issue:`2005`) + +- Fix Name LSA comparison which could cause incorrect advertised names to be removed (:issue:`2029`) + +- Fix issue where more faces than max-faces-per-prefix could be applied to a prefix (:issue:`2018`) + +- Stop LSDB from retrieving and out of date LSA when a new one is detected (:issue:`1987`) + +- Correct mistakes in documentation + +- Correct bitmask used to copy Name LSA sequence number (:issue:`2323`) \ No newline at end of file diff --git a/docs/release-notes/release-notes-0.2.1.rst b/docs/release-notes/release-notes-0.2.1.rst new file mode 100644 index 0000000..20fbba7 --- /dev/null +++ b/docs/release-notes/release-notes-0.2.1.rst @@ -0,0 +1,20 @@ +NLSR version 0.2.1 (changes since version 0.2.0) +++++++++++++++++++++++++++++++++++++++++++++++++ + +Release date: June 30, 2015 + +**Code changes**: + +- Using a configuration file without ``prefix-update-validator`` disables runtime advertise/withdraw instead of exiting (:issue:`2814`) + +**Bug fixes**: + +- Prevent incomplete removal of NPT entry (:issue:`2785`) + +- Correct bidirectional links with differing costs (:issue:`2801`) + +- Fix non-incrementing Adjacency number in AdjLsa::writeLog (:issue:`2594`) + +- Remove FaceDestroyEvent test's reliance on nlsrSeqNo.txt (:issue:`2881`) + +- Test ACTIVE/INACTIVE Adjacencies in LSA construction (:issue:`2735`) \ No newline at end of file diff --git a/docs/release-notes/release-notes-0.2.2.rst b/docs/release-notes/release-notes-0.2.2.rst new file mode 100644 index 0000000..0b74fa8 --- /dev/null +++ b/docs/release-notes/release-notes-0.2.2.rst @@ -0,0 +1,8 @@ +NLSR version 0.2.2 (changes since version 0.2.1) +++++++++++++++++++++++++++++++++++++++++++++++++ + +Release date: January 5, 2016 + +**Code changes**: + +- Adapt code to changes in NFD/ndn-cxx version 0.4.0 release \ No newline at end of file diff --git a/docs/release-notes/release-notes-0.3.0.rst b/docs/release-notes/release-notes-0.3.0.rst new file mode 100644 index 0000000..c535443 --- /dev/null +++ b/docs/release-notes/release-notes-0.3.0.rst @@ -0,0 +1,26 @@ +NLSR version 0.3.0 (changes since version 0.2.2) +++++++++++++++++++++++++++++++++++++++++++++++++ + +Release date: August 1, 2016 + +**Code changes**: + +- Updated validation checker for LSA rule in the configuration file (:issue:`2965`) + +- Do not advertise Adjacency LSAs when hyperbolic routing is enabled (:issue:`2402`) + +- Do not distribute coordinate LSAs when using link-state routing. (:issue:`3661`) + +- LSAs should be segmented before they are published (:issue:`2965`) + +- Don't use DummyClientFace::sentDatas (:issue:`3383`) + +- Remove disabled security files (:issue:`2960`) + +- Lsa type should be argument for base class LSA constructor (:issue:`2788`) + +- Use ndn-cxx/DummyClientFace (:issue:`2637`) + +**Bug fixes**: + +- Unit tests cases are installed with `./waf install` (:issue:`3359`) \ No newline at end of file diff --git a/docs/release-notes/release-notes-0.3.1.rst b/docs/release-notes/release-notes-0.3.1.rst new file mode 100644 index 0000000..5ffcd7c --- /dev/null +++ b/docs/release-notes/release-notes-0.3.1.rst @@ -0,0 +1,34 @@ +NLSR version 0.3.1 (changes since version 0.3.0) +++++++++++++++++++++++++++++++++++++++++++++++++ + +Release date: January 22, 2017 + +**Changes** + +- **breaking change** Sync uses /localhop component in prefix to reduce duplicate NACKs (:issue:`3627`) + +- **breaking change** LSA uses /localhop component in prefix to reduce duplicate NACKs (:issue:`3899`) + +**Code Changes**: + +- Fib and FaceMap use std::map instead of std::list (:issue:`2781`) + +- NamePrefixTableEntries store RoutingTableEntries using a pointer (:issue:`2863`) + +- Namespace closing comments are now consistent with ndn-cxx guidelines (:issue:`3735`) + +- Update copyright date across all files (:issue:`3736`, `3909`, `3923`) + +- Improve formatting of FaceMap and FaceMapEntry (:issue:`3737`) + +- Sort NextHops on NexthopList insertion (:issue:`2721`) + +**Bug fixes**: + +- HR now recalculates paths after status change of a neighbor (:issue:`3874`) + +- NLSR no longer sets strategies multiple times (:issue:`3743`) + +- NLSR should enable use of ndn-cxx dispatcher (:issue:`3930`) + +- Fix typos in the sample configuration file (:issue:`3113`) \ No newline at end of file diff --git a/docs/release-notes/release-notes-0.3.2.rst b/docs/release-notes/release-notes-0.3.2.rst new file mode 100644 index 0000000..788321e --- /dev/null +++ b/docs/release-notes/release-notes-0.3.2.rst @@ -0,0 +1,20 @@ +NLSR version 0.3.2 (changes since version 0.3.1) +++++++++++++++++++++++++++++++++++++++++++++++++ + +Release date: March 15, 2017 + +**Changes** + +- NLSR constructor now accept a KeyChain argument. (:issue:`3742`) + +- Fix security rule for /localhop LSA prefix (:issue:`3899`) + +- Use ndn::nfd::ROUTE_ORIGIN_NLSR instead of a magic number. (:issue:`3903`) + +- Handle "Face Already Exists" error (error code 409) in NFD. (:issue:`3976`) + +- Enable NLSR to register localhost prefix with dispatcher before top-level prefix. (:issue:`3938`) + +- Don't use ndn aliases provided by ndn-cxx/common.hpp. (:issue:`3983`) + +- Remove use of deprecated code. (:issue:`3988`) \ No newline at end of file diff --git a/docs/release-notes/release-notes-0.4.0.rst b/docs/release-notes/release-notes-0.4.0.rst new file mode 100644 index 0000000..309b8f7 --- /dev/null +++ b/docs/release-notes/release-notes-0.4.0.rst @@ -0,0 +1,79 @@ +NLSR version 0.4.0 +++++++++++++++++++ + +**New features**: + +- **breaking change** Discover Faces from NFD (:issue:`2954`) + +- **breaking change** Accommodate n-Dimensional HR coordinates (:issue:`3751`) + +**Changes**: + +- **breaking change** Make chronosync a dependency (:issue:`2400`) + +- **breaking change** Use separate name prefix and sequence number + for each LSA type (:issue:`3964`) + +- **breaking change** Convert to ``v2::security`` and adapt to ndn-cxx changes (:issue:`3964`) + +- Use unix timestamp as default (:issue:`4187`) + +**Bug Fixes**: + +- Add support for sources to NamePrefixList (:issue:`4177`) + +- Fix incorrect error on face-dataset-fetch-interval valid values (:issue:`4211`) + +- Fix prefix advertise runtime error (:issue:`4215`) + +- Fix heap buffer overflow error (:issue:`4217`) + +**Code Changes**: + +- LSA getData() now uses ostream instead of manually building the string (:issue:`2346`) + +- Refresh FIB entries independently of routing table calculation (:issue:`2778`) + +- Change configuration parameter output level to info (:issue:`2850`) + +- Updates to name prefixes are more efficient (:issue:`2864`) + +- Implement statistics collector/recorder (:issue:`2956`) + +- Implement ``NameLsa::isEqualContent`` (:issue:`2962`) + +- Refactor ``Fib::removeOldNextHopsFromFibEntryAndNfd()`` for simplicity, readability. (:issue:`3820`) + +- Improve logging throughout lsdb.cpp and others (:issue:`3934`) + +- Enable dispatcher for LOCALHOST_PREFIX (:issue:`3938`) + +- Don't use ndn aliases provided by ndn-cxx/common.hpp (:issue:`3983`) + +- Canonize Adjacent FaceURIs on startup (:issue:`4063`) + +- Refactor AdjacencyList to use iterators instead of bare ptrs (:issue:`4068`) + +- Merge redundant functions (:issue:`4105`) + +- Remove writeLog in NamePrefixList (:issue:`4131`) + +- Check for self in ChronoSync updates (:issue:`4134`) + +- Install nlsr.conf as sample in the system (:issue:`4197`) + +- Enable AddressSanitizer and LeakSanitizer for unit tests (:issue:`4206`) + +- Resolve all ASan errors in unit tests (:issue:`4230`) + +- Simplified LSDB dataset interest handler. (:issue:`4235`) + +- Made map more container-agnostic (:issue:`4239`) + +- Improved routing map data structure. (:issue:`4240`) + +- Increased independence of SyncLogicHandler (:issue:`4264`) + +- Use unique_ptr for signal container (:issue:`4268`) + +- Use network name in sync prefix to avoid sync leaks from other networks (:issue:`4101`) diff --git a/docs/releases.rst b/docs/releases.rst new file mode 100644 index 0000000..126e753 --- /dev/null +++ b/docs/releases.rst @@ -0,0 +1,63 @@ +NLSR Versions ++++++++++++++ + +.. toctree:: + :hidden: + :maxdepth: 1 + + release-notes/release-notes-0.4.0 + release-notes/release-notes-0.3.2 + release-notes/release-notes-0.3.1 + release-notes/release-notes-0.3.0 + release-notes/release-notes-0.2.2 + release-notes/release-notes-0.2.1 + release-notes/release-notes-0.2.0 + release-notes/release-notes-0.1.0 + +* **NLSR version 0.4.0** + (:doc:`Release Notes `, `Documentation `__) + + `src (git) `__, + `src (tarball) `__ (`checksum `__) + +* **NLSR version 0.3.2** + (:doc:`Release Notes `, `Documentation `__) + + `src (git) `__, + `src (tarball) `__ (`checksum `__) + +* **NLSR version 0.3.1** + (:doc:`Release Notes `, `Documentation `__) + + `src (git) `__, + `src (tarball) `__ (`checksum `__) + +* **NLSR version 0.3.0** + (:doc:`Release Notes `, `Documentation `__) + + `src (git) `__, + `src (tarball) `__ (`checksum `__) + +* **NLSR version 0.2.2** + (:doc:`Release Notes `, `Documentation `__) + + `src (git) `__, + `src (tarball) `__ (`checksum `__) + +* **NLSR version 0.2.1** + (:doc:`Release Notes `, `Documentation `__) + + `src (git) `__, + `src (tarball) `__ (`checksum `__) + +* **NLSR version 0.2.0** + (:doc:`Release Notes `, `Documentation `__) + + `src (git) `__, + `src (tarball) `__ (`checksum `__) + +* **NLSR version 0.1.0** + (:doc:`Release Notes `, `Documentation `__) + + `src (git) `__, + `src (tarball) `__ (`checksum `__) diff --git a/wscript b/wscript index f599297..96f2980 100644 --- a/wscript +++ b/wscript @@ -20,7 +20,7 @@ You should have received a copy of the GNU General Public License along with NLSR, e.g., in COPYING.md file. If not, see . """ -VERSION = "0.3.2" +VERSION = "0.4.0" APPNAME = "nlsr" BUGREPORT = "https://redmine.named-data.net/projects/nlsr" URL = "https://named-data.net/doc/NLSR/"