Skip to content

Commit b65d6db

Browse files
committed
docs: improve release history page
And also fix the date and a few typos in the release notes Change-Id: Ia5d8325b78c9819f6be0b27729bc13d6d6f1e403
1 parent 880e715 commit b65d6db

4 files changed

Lines changed: 45 additions & 57 deletions

File tree

docs/doxygen.conf.in

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1171,15 +1171,6 @@ HTML_COLORSTYLE_SAT = 0
11711171

11721172
HTML_COLORSTYLE_GAMMA = 91
11731173

1174-
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1175-
# page will contain the date and time when the page was generated. Setting this
1176-
# to YES can help to show when doxygen was last run and thus if the
1177-
# documentation is up to date.
1178-
# The default value is: NO.
1179-
# This tag requires that the tag GENERATE_HTML is set to YES.
1180-
1181-
HTML_TIMESTAMP = NO
1182-
11831174
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
11841175
# documentation will contain sections that can be hidden and shown after the
11851176
# page has loaded.
@@ -1747,14 +1738,6 @@ LATEX_HIDE_INDICES = NO
17471738

17481739
LATEX_BIB_STYLE = plain
17491740

1750-
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1751-
# page will contain the date and time when the page was generated. Setting this
1752-
# to NO can help when comparing the output of multiple runs.
1753-
# The default value is: NO.
1754-
# This tag requires that the tag GENERATE_LATEX is set to YES.
1755-
1756-
LATEX_TIMESTAMP = NO
1757-
17581741
#---------------------------------------------------------------------------
17591742
# Configuration options related to the RTF output
17601743
#---------------------------------------------------------------------------
@@ -2088,15 +2071,6 @@ EXTERNAL_PAGES = YES
20882071
# Configuration options related to the dot tool
20892072
#---------------------------------------------------------------------------
20902073

2091-
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2092-
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2093-
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2094-
# disabled, but it is recommended to install and use dot, since it yields more
2095-
# powerful graphs.
2096-
# The default value is: YES.
2097-
2098-
CLASS_DIAGRAMS = YES
2099-
21002074
# You can include diagrams made with dia in doxygen documentation. Doxygen will
21012075
# then run dia to produce the diagram and insert it in the documentation. The
21022076
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
@@ -2129,23 +2103,6 @@ HAVE_DOT = @HAVE_DOT@
21292103

21302104
DOT_NUM_THREADS = 0
21312105

2132-
# When you want a differently looking font in the dot files that doxygen
2133-
# generates you can specify the font name using DOT_FONTNAME. You need to make
2134-
# sure dot is able to find the font, which can be done by putting it in a
2135-
# standard location or by setting the DOTFONTPATH environment variable or by
2136-
# setting DOT_FONTPATH to the directory containing the font.
2137-
# The default value is: Helvetica.
2138-
# This tag requires that the tag HAVE_DOT is set to YES.
2139-
2140-
DOT_FONTNAME = Helvetica
2141-
2142-
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2143-
# dot graphs.
2144-
# Minimum value: 4, maximum value: 24, default value: 10.
2145-
# This tag requires that the tag HAVE_DOT is set to YES.
2146-
2147-
DOT_FONTSIZE = 10
2148-
21492106
# By default doxygen will tell dot to use the default font as specified with
21502107
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
21512108
# the path where dot can find it using this tag.
Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,33 @@
11
PSync version 0.5.0
22
-------------------
33

4-
*Release date: July XX, 2024*
4+
*Release date: August 9, 2024*
55

66
Important changes and new features
77
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
88

99
- The build dependencies have been increased as follows:
10+
1011
- GCC >= 9.3 or Clang >= 7.0 are strongly *recommended* on Linux; GCC 8.x is also known
11-
to work but is not officially supported
12+
to work but is not officially supported
1213
- Xcode 13 or later is *recommended* on macOS; older versions may still work but are not
13-
officially supported
14-
- Boost >= 1.71.0 is *required* on all platforms
15-
- We have officially moved to a modified FullSync algorithim originally designed by Ashlesh
16-
Gawande as part of `his thesis work
14+
officially supported
15+
- Boost >= 1.71.0 and ndn-cxx >= 0.9.0 are *required* on all platforms
16+
17+
- We have moved to a modified FullSync algorithm originally designed by Ashlesh Gawande
18+
as part of `his thesis work
1719
<https://digitalcommons.memphis.edu/cgi/viewcontent.cgi?article=3162&context=etd>`__.
1820
These changes are intended to lower delay and overhead when using FullSync
1921

2022
Improvements and bug fixes
2123
^^^^^^^^^^^^^^^^^^^^^^^^^^
2224

23-
- Constructor options are now passed in as single ``Options`` object (:issue:`5069`)
24-
- :psync:`FullProducer` no longer appends the hash of the IBF to the data name; this had no functional
25-
purpose (:issue:`5066`)
25+
- Constructor options are now passed in as a single ``Options`` object; the old constructor
26+
API is considered deprecated (:issue:`5069`)
27+
- :psync:`FullProducer` no longer appends the hash of the IBF to the data name; this had no
28+
functional purpose (:issue:`5066`)
2629
- Refactoring of IBLT implementation (:issue:`4825`)
2730
- Various adjustments to match ndn-cxx namespace changes
28-
- Update waf build system to version 2.0.27
2931
- Fix building the documentation with Python 3.12 (:issue:`5298`)
30-
- Miscellanous CI and build improvements
32+
- Update waf build system to version 2.0.27
33+
- Miscellanous CI and build improvements

docs/releases.rst

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,37 @@
1-
PSync Versions
2-
==============
1+
Release History
2+
===============
33

44
.. toctree::
55
:glob:
6+
:hidden:
67
:maxdepth: 1
78
:reversed:
89

910
release-notes/*
11+
12+
* **PSync version 0.5.0**
13+
\| :doc:`Release Notes <release-notes/release-notes-0.5.0>`
14+
\| `GitHub <https://github.com/named-data/PSync/releases/tag/0.5.0>`__
15+
\| `Source download <https://github.com/named-data/PSync/releases/download/0.5.0/psync-0.5.0.tar.xz>`__
16+
(`checksum <https://github.com/named-data/PSync/releases/download/0.5.0/psync-0.5.0.tar.xz.sha256>`__)
17+
\| `Documentation <https://docs.named-data.net/PSync/0.5.0/>`__
18+
19+
* **PSync version 0.4.0**
20+
\| :doc:`Release Notes <release-notes/release-notes-0.4.0>`
21+
\| `GitHub <https://github.com/named-data/PSync/releases/tag/0.4.0>`__
22+
\| `Documentation <https://docs.named-data.net/PSync/0.4.0/>`__
23+
24+
* **PSync version 0.3.0**
25+
\| :doc:`Release Notes <release-notes/release-notes-0.3.0>`
26+
\| `GitHub <https://github.com/named-data/PSync/releases/tag/0.3.0>`__
27+
\| `Documentation <https://docs.named-data.net/PSync/0.3.0/>`__
28+
29+
* **PSync version 0.2.0**
30+
\| :doc:`Release Notes <release-notes/release-notes-0.2.0>`
31+
\| `GitHub <https://github.com/named-data/PSync/releases/tag/0.2.0>`__
32+
\| `Documentation <https://docs.named-data.net/PSync/0.2.0/>`__
33+
34+
* **PSync version 0.1.0**
35+
\| :doc:`Release Notes <release-notes/release-notes-0.1.0>`
36+
\| `GitHub <https://github.com/named-data/PSync/releases/tag/0.1.0>`__
37+
\| `Documentation <https://docs.named-data.net/PSync/0.1.0/>`__

wscript

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import subprocess
55
from waflib import Context, Logs
66

77
VERSION = '0.5.0'
8-
APPNAME = 'PSync'
8+
APPNAME = 'psync'
99
GIT_TAG_PREFIX = ''
1010

1111
BOOST_COMPRESSION_CODE = '''

0 commit comments

Comments
 (0)