docs: Documentation corrections
Installation instructions incorrectly suggested to install ndn-cxx
package from Ubuntu PPA archive. Instead, ndn-cxx-dev package should be
installed.
Change-Id: I68a645011f31ba7b3a63fda0fb2811006a83e8ef
diff --git a/docs/Doxyfile b/docs/Doxyfile
index 878da69..c69fcb2 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -1965,7 +1965,9 @@
PROTECTED_WITH_TESTS_ELSE_PRIVATE=private \
VIRTUAL_WITH_TESTS \
DECL_OVERRIDE \
- ATTRIBUTE_HELPER_CPP
+ ATTRIBUTE_HELPER_CPP \
+ NDN_CXX_KEYCHAIN_REGISTER_PIB \
+ NDN_CXX_KEYCHAIN_REGISTER_TPM
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
diff --git a/docs/source/faq.rst b/docs/source/faq.rst
index 2a83682..cad083a 100644
--- a/docs/source/faq.rst
+++ b/docs/source/faq.rst
@@ -5,8 +5,7 @@
---------------
.. note::
- **My ubuntu/redhat/freebsd have an old version of boost libraries. How can I get the
- latest one?**
+ **My ubuntu/redhat/freebsd have an old version of boost libraries. How can I get the latest one?**
.. _Installing boost libraries:
@@ -16,8 +15,7 @@
.. role:: red
.. note::
- **The following instructions are for those who want to install latest version of boost
- libraries** :red:`and has root access`.
+ **The following instructions are for those who want to install latest version of boost libraries** :red:`and has root access`.
The following commands would install the latest version of boost libraries (at the time of
writing, version 1.53) ot ``/usr/local``, assuming you have a root access to your machine. If
@@ -157,5 +155,4 @@
I found an error in the documentation / bug in the code. What should I do?
Please submit a bug report on `redmine <http://redmine.named-data.net/projects/ndnsim?jump=welcome>`_,
-or tell us about the error on `our mailing list
-<http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim>`_ .
+or tell us about the error on `our mailing list <http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim>`_ .
diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst
index a56fbe1..7d3e927 100644
--- a/docs/source/getting-started.rst
+++ b/docs/source/getting-started.rst
@@ -142,7 +142,11 @@
.. code-block:: bash
- sudo apt-get install ndn-cxx
+ sudo apt-get install ndn-cxx-dev
+
+ If you are using ndn-cxx from PPA, please make sure that you do not have the existing installation
+ of ndn-cxx library compiled from source (e.g., in /usr/local). Otherwise, the version mistmach
+ may result in compilation errors.
- Compile NS-3 with ndnSIM module