Prepare release 2.8
Change-Id: I98c36a7763387cd27df88713e68035dff222b187
diff --git a/docs/source/RELEASE_NOTES.rst b/docs/source/RELEASE_NOTES.rst
index 4e2187d..bd0b38e 100644
--- a/docs/source/RELEASE_NOTES.rst
+++ b/docs/source/RELEASE_NOTES.rst
@@ -5,6 +5,32 @@
All of the ndnSIM documentation is accessible from the `ndnSIM website <https://ndnsim.net>`__.
+Release 2.8
+-----------
+
+- The submodules of NFD and ndn-cxx have been upgraded to version 0.7.0.
+
+ `NFD 0.7.0 release notes <https://named-data.net/doc/NFD/0.7.0/RELEASE_NOTES.html>`__
+
+ `ndn-cxx 0.7.0 release notes <https://named-data.net/doc/ndn-cxx/0.7.0/RELEASE_NOTES.html>`__
+
+ .. note::
+ In order to retrieve the marked versions of ndn-cxx and NFD, use
+ ``--recursive`` option to the git clone command or run ``git
+ submodule update --init`` after clone, pull, or merge.
+
+- With the underlying NFD/ndn-cxx upgrade, ndnSIM now operates with NDN Packet format version 0.3.
+
+- Base NS-3 was rebased to version 3.30.1
+
+- Add Loop-Free In-port Dependent (LFID) route calculation that provides a set of
+ loop-free paths (:issue:`4985`)
+
+- Fix wrong behaviour of default Size in ConsumerWindow
+
+- **Remove** legacy content store implementation. Use content store replacement/placement
+ policies implemented using NFD routines.
+
Release 2.7
-----------
diff --git a/docs/source/_templates/indexcontent.html b/docs/source/_templates/indexcontent.html
index 71289dd..c5810a1 100644
--- a/docs/source/_templates/indexcontent.html
+++ b/docs/source/_templates/indexcontent.html
@@ -59,8 +59,9 @@
<td width="50%" valign="top">
<h2>ndnSIM Versions</h2>
<div class="tile">
- <p class="biglink"><a class="biglink" href="#">ndnSIM 2.7</a><br/>
- <span class="linkdescr">latest version</span></p>
+ <p class="biglink"><a class="biglink" href="#">ndnSIM 2.8</a><br/>
+ <span class="linkdescr">the latest version</span></p>
+ <p class="biglink"><a class="biglink" href="https://ndnsim.net/2.7/">ndnSIM 2.7</a><br/>
<p class="biglink"><a class="biglink" href="https://ndnsim.net/2.6/">ndnSIM 2.6</a><br/>
<p class="biglink"><a class="biglink" href="https://ndnsim.net/2.5/">ndnSIM 2.5</a><br/>
<p class="biglink"><a class="biglink" href="https://ndnsim.net/2.4/">ndnSIM 2.4</a><br/>
diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst
index 1749051..b1a42ff 100644
--- a/docs/source/getting-started.rst
+++ b/docs/source/getting-started.rst
@@ -9,9 +9,9 @@
ndnSIM 2.x has been successfully compiled and used on following platforms:
+- Ubuntu Linux 20.04
- Ubuntu Linux 18.04
-- Ubuntu Linux 16.04
-- macOS 10.13
+- macOS 10.15
- macOS 10.14
.. _requirements:
@@ -21,7 +21,7 @@
**1. Core dependencies**
-- ``python`` >= 2.7
+- ``python`` >= 3.5
- ``libsqlite3``
- ``pkg-config``
- ``openssl``
@@ -50,12 +50,18 @@
- Linux
- * Ubuntu Linux
+ * Ubuntu Linux 18.04
.. code-block:: bash
sudo apt install build-essential libsqlite3-dev libboost-all-dev libssl-dev git python-setuptools castxml
+ * Ubuntu Linux 20.04
+
+ .. code-block:: bash
+
+ sudo apt install build-essential libsqlite3-dev libboost-all-dev libssl-dev git python3-setuptools castxml
+
* Fedora Linux
.. code-block:: bash
@@ -87,13 +93,18 @@
- Linux
- * Ubuntu Linux
+ * Ubuntu Linux 18.04
.. code-block:: bash
sudo apt install python-dev python-pygraphviz python-kiwi python-gnome2 ipython libcairo2-dev python3-gi libgirepository1.0-dev python-gi python-gi-cairo gir1.2-gtk-3.0 gir1.2-goocanvas-2.0 python-pip
sudo pip install pygraphviz pycairo PyGObject pygccxml
+ * Ubuntu Linux 20.04
+
+ sudo apt install gir1.2-goocanvas-2.0 gir1.2-gtk-3.0 libgirepository1.0-dev python3-dev python3-gi python3-gi-cairo python3-pip python3-pygraphviz python3-pygccxml
+ sudo pip3 install kiwi
+
.. _visualizer: https://www.nsnam.org/wiki/PyViz
Downloading ndnSIM source
@@ -148,16 +159,6 @@
./waf configure --enable-examples
./waf
-On macOS (with MacPorts), you may need to modify the configure command to use MacPorts
-version of python:
-
-.. code-block:: bash
-
- cd <ns-3-folder>
- ./waf configure --with-python=/opt/local/bin/python2.7 --enable-examples
- # or run ``sudo port select python python27``
- ./waf
-
.. note::
On macOS configuration stage may get :ref:`stuck at detecting gtk module <Problems with
the gtk python module on macOS>`. Make sure you have `XQuartz