docs: improve release history page
And also fix the date and a few typos in the release notes
Change-Id: Ia5d8325b78c9819f6be0b27729bc13d6d6f1e403
diff --git a/docs/doxygen.conf.in b/docs/doxygen.conf.in
index 26a8b4e..25b5f92 100644
--- a/docs/doxygen.conf.in
+++ b/docs/doxygen.conf.in
@@ -1171,15 +1171,6 @@
HTML_COLORSTYLE_GAMMA = 91
-# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
-# page will contain the date and time when the page was generated. Setting this
-# to YES can help to show when doxygen was last run and thus if the
-# documentation is up to date.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_TIMESTAMP = NO
-
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
@@ -1747,14 +1738,6 @@
LATEX_BIB_STYLE = plain
-# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
-# page will contain the date and time when the page was generated. Setting this
-# to NO can help when comparing the output of multiple runs.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_TIMESTAMP = NO
-
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
@@ -2088,15 +2071,6 @@
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
-# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
-# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
-# NO turns the diagrams off. Note that this option also works with HAVE_DOT
-# disabled, but it is recommended to install and use dot, since it yields more
-# powerful graphs.
-# The default value is: YES.
-
-CLASS_DIAGRAMS = YES
-
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
@@ -2129,23 +2103,6 @@
DOT_NUM_THREADS = 0
-# When you want a differently looking font in the dot files that doxygen
-# generates you can specify the font name using DOT_FONTNAME. You need to make
-# sure dot is able to find the font, which can be done by putting it in a
-# standard location or by setting the DOTFONTPATH environment variable or by
-# setting DOT_FONTPATH to the directory containing the font.
-# The default value is: Helvetica.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_FONTNAME = Helvetica
-
-# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
-# dot graphs.
-# Minimum value: 4, maximum value: 24, default value: 10.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_FONTSIZE = 10
-
# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
diff --git a/docs/release-notes/release-notes-0.5.0.rst b/docs/release-notes/release-notes-0.5.0.rst
index dc9bb5e..f7d634b 100644
--- a/docs/release-notes/release-notes-0.5.0.rst
+++ b/docs/release-notes/release-notes-0.5.0.rst
@@ -1,30 +1,33 @@
PSync version 0.5.0
-------------------
-*Release date: July XX, 2024*
+*Release date: August 9, 2024*
Important changes and new features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- The build dependencies have been increased as follows:
+
- GCC >= 9.3 or Clang >= 7.0 are strongly *recommended* on Linux; GCC 8.x is also known
- to work but is not officially supported
+ to work but is not officially supported
- Xcode 13 or later is *recommended* on macOS; older versions may still work but are not
- officially supported
- - Boost >= 1.71.0 is *required* on all platforms
-- We have officially moved to a modified FullSync algorithim originally designed by Ashlesh
- Gawande as part of `his thesis work
+ officially supported
+ - Boost >= 1.71.0 and ndn-cxx >= 0.9.0 are *required* on all platforms
+
+- We have moved to a modified FullSync algorithm originally designed by Ashlesh Gawande
+ as part of `his thesis work
<https://digitalcommons.memphis.edu/cgi/viewcontent.cgi?article=3162&context=etd>`__.
These changes are intended to lower delay and overhead when using FullSync
Improvements and bug fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^
-- Constructor options are now passed in as single ``Options`` object (:issue:`5069`)
-- :psync:`FullProducer` no longer appends the hash of the IBF to the data name; this had no functional
- purpose (:issue:`5066`)
+- Constructor options are now passed in as a single ``Options`` object; the old constructor
+ API is considered deprecated (:issue:`5069`)
+- :psync:`FullProducer` no longer appends the hash of the IBF to the data name; this had no
+ functional purpose (:issue:`5066`)
- Refactoring of IBLT implementation (:issue:`4825`)
- Various adjustments to match ndn-cxx namespace changes
-- Update waf build system to version 2.0.27
- Fix building the documentation with Python 3.12 (:issue:`5298`)
-- Miscellanous CI and build improvements
\ No newline at end of file
+- Update waf build system to version 2.0.27
+- Miscellanous CI and build improvements
diff --git a/docs/releases.rst b/docs/releases.rst
index 148f90c..ac2a7b8 100644
--- a/docs/releases.rst
+++ b/docs/releases.rst
@@ -1,9 +1,37 @@
-PSync Versions
-==============
+Release History
+===============
.. toctree::
:glob:
+ :hidden:
:maxdepth: 1
:reversed:
release-notes/*
+
+* **PSync version 0.5.0**
+ \| :doc:`Release Notes <release-notes/release-notes-0.5.0>`
+ \| `GitHub <https://github.com/named-data/PSync/releases/tag/0.5.0>`__
+ \| `Source download <https://github.com/named-data/PSync/releases/download/0.5.0/psync-0.5.0.tar.xz>`__
+ (`checksum <https://github.com/named-data/PSync/releases/download/0.5.0/psync-0.5.0.tar.xz.sha256>`__)
+ \| `Documentation <https://docs.named-data.net/PSync/0.5.0/>`__
+
+* **PSync version 0.4.0**
+ \| :doc:`Release Notes <release-notes/release-notes-0.4.0>`
+ \| `GitHub <https://github.com/named-data/PSync/releases/tag/0.4.0>`__
+ \| `Documentation <https://docs.named-data.net/PSync/0.4.0/>`__
+
+* **PSync version 0.3.0**
+ \| :doc:`Release Notes <release-notes/release-notes-0.3.0>`
+ \| `GitHub <https://github.com/named-data/PSync/releases/tag/0.3.0>`__
+ \| `Documentation <https://docs.named-data.net/PSync/0.3.0/>`__
+
+* **PSync version 0.2.0**
+ \| :doc:`Release Notes <release-notes/release-notes-0.2.0>`
+ \| `GitHub <https://github.com/named-data/PSync/releases/tag/0.2.0>`__
+ \| `Documentation <https://docs.named-data.net/PSync/0.2.0/>`__
+
+* **PSync version 0.1.0**
+ \| :doc:`Release Notes <release-notes/release-notes-0.1.0>`
+ \| `GitHub <https://github.com/named-data/PSync/releases/tag/0.1.0>`__
+ \| `Documentation <https://docs.named-data.net/PSync/0.1.0/>`__
diff --git a/wscript b/wscript
index d19fcba..ad0e800 100644
--- a/wscript
+++ b/wscript
@@ -5,7 +5,7 @@
from waflib import Context, Logs
VERSION = '0.5.0'
-APPNAME = 'PSync'
+APPNAME = 'psync'
GIT_TAG_PREFIX = ''
BOOST_COMPRESSION_CODE = '''