Do not compile ChronoSync support by default
ChronoSync dependency is now made optional
and is kept for testing purposes only.
Also change sig-type to ecdsa-sha256 in nlsr.conf
as ndn-cxx now has strict checking for it.
refs: #5147
Change-Id: I95c9fb844681ebf2c4e7bbb03cc7796a0795de83
diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst
index f496919..d66d59f 100644
--- a/docs/INSTALL.rst
+++ b/docs/INSTALL.rst
@@ -12,16 +12,17 @@
Refer to `Getting started with NFD <https://named-data.net/doc/NFD/current/INSTALL.html>`_
for detailed installation and running instruction.
-- ChronoSync library
-
-Download the ChronoSync library and build it according to the instructions available at
-https://github.com/named-data/ChronoSync#build
-
- PSync library
Download the PSync library and build it according to the instructions available at
https://github.com/named-data/PSync#build
+- [Optional] ChronoSync library
+
+For testing purposes, NLSR can be optionally built with Chronosync support.
+Download the ChronoSync library and build it according to the instructions available at
+https://github.com/named-data/ChronoSync#build
+
Build
-----
@@ -40,3 +41,7 @@
export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
# or
export PKG_CONFIG_PATH=/path/to/pkgconfig/on/your/machine
+
+If ChronoSync support is desired, NLSR needs to be configured with the following option:
+
+ ./waf configure --with-chronosync
diff --git a/docs/beginners-guide.rst b/docs/beginners-guide.rst
index 9807191..8cc7e99 100644
--- a/docs/beginners-guide.rst
+++ b/docs/beginners-guide.rst
@@ -18,7 +18,7 @@
The following instructions are based on the information provided at the
Named Data Networking project web page [NDNmain]_.
Before installing NLSR it is necessary to install different libraries
-and programs: ndn-cxx, NFD, ChronoSync, and PSync. This document describes the
+and programs: ndn-cxx, NFD, ChronoSync [optional], and PSync. This document describes the
necessary steps to correctly install these programs (§ `2 <#ndncxx>`__,
`3 <#nfd>`__ and `4 <#nlsr>`__) and a brief guide on how to configure
and test NLSR using a simple two-node network (§ `5 <#test>`__).
@@ -361,8 +361,40 @@
4. Installing NLSR
==================
-4.1 Installing ChronoSync
--------------------------
+4.1 Installing PSync
+--------------------
+
+Before installing NLSR, it is also necessary to download and install
+PSync. PSync is a synchronization library which allows NLSR to synchronize LSAs
+similar to ChronoSync. More information about PSync may be found at [PSync]_.
+This library may be installed by running the following commands as a regular
+user and at the directory defined at § `1 <#intro>`__:
+
+::
+
+ $ git clone --depth 1 https://github.com/named-data/PSync.git
+ $ cd PSync
+ $ ./waf configure
+ $ ./waf
+ $ sudo ./waf install
+
+The following command needs to be used again to configure the libraries:
+
+::
+
+ $ sudo ldconfig -v | grep -i psync
+
+This command should display a line similar to the following:
+
+::
+
+ libPSync.so.0.1.0 -> libPSync.so.0.1.0
+
+4.2 [Optional] Installing ChronoSync
+------------------------------------
+
+By default NLSR no longer builds with ChronoSync support.
+Since ChronoSync is deprecated, only install it for testing purposes.
Before installing NLSR, it is necessary to first download and install
ChronoSync, which is a synchronization library which allows NLSR routers
@@ -391,35 +423,6 @@
libChronoSync.so.0.5.0 -> libChronoSync.so.0.5.0
-4.2 Installing PSync
--------------------------
-
-Before installing NLSR, it is also necessary to download and install
-PSync. PSync is a synchronization library which allows NLSR to synchronize LSAs
-similar to ChronoSync. More information about PSync may be found at [PSync]_.
-This library may be installed by running the following commands as a regular
-user and at the directory defined at § `1 <#intro>`__:
-
-::
-
- $ git clone --depth 1 https://github.com/named-data/PSync.git
- $ cd PSync
- $ ./waf configure
- $ ./waf
- $ sudo ./waf install
-
-The following command needs to be used again to configure the libraries:
-
-::
-
- $ sudo ldconfig -v | grep -i psync
-
-This command should display a line similar to the following:
-
-::
-
- libPSync.so.0.1.0 -> libPSync.so.0.1.0
-
4.3 Downloading and installing NLSR
-----------------------------------
@@ -435,6 +438,12 @@
$ ./waf
$ sudo ./waf install
+If ChronoSync support is needed for testing, please configure NLSR with:
+
+::
+
+ $ ./waf configure --with-chronosync
+
4.4 Configuring NLSR
--------------------