Skip to content

Commit 0751bba

Browse files
committed
Prepare release 0.9.0
Refs: #5323 Change-Id: Ifd67ae391221916679e79b7a321163792ca3af95
1 parent 7fffb72 commit 0751bba

File tree

6 files changed

+136
-48
lines changed

6 files changed

+136
-48
lines changed

.jenkins.d/00-deps.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ esac
3535
set -x
3636

3737
if [[ $ID == macos ]]; then
38+
export HOMEBREW_NO_ENV_HINTS=1
3839
if [[ -n $GITHUB_ACTIONS ]]; then
3940
export HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=1
4041
fi

docs/doxygen.conf.in

Lines changed: 0 additions & 34 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
#---------------------------------------------------------------------------
@@ -2122,23 +2105,6 @@ HAVE_DOT = @HAVE_DOT@
21222105

21232106
DOT_NUM_THREADS = 0
21242107

2125-
# When you want a differently looking font in the dot files that doxygen
2126-
# generates you can specify the font name using DOT_FONTNAME. You need to make
2127-
# sure dot is able to find the font, which can be done by putting it in a
2128-
# standard location or by setting the DOTFONTPATH environment variable or by
2129-
# setting DOT_FONTPATH to the directory containing the font.
2130-
# The default value is: Helvetica.
2131-
# This tag requires that the tag HAVE_DOT is set to YES.
2132-
2133-
DOT_FONTNAME = Helvetica
2134-
2135-
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2136-
# dot graphs.
2137-
# Minimum value: 4, maximum value: 24, default value: 10.
2138-
# This tag requires that the tag HAVE_DOT is set to YES.
2139-
2140-
DOT_FONTSIZE = 10
2141-
21422108
# By default doxygen will tell dot to use the default font as specified with
21432109
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
21442110
# the path where dot can find it using this tag.

docs/release-notes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Release Notes
22
=============
33

4-
.. include:: release-notes/release-notes-0.8.1.rst
4+
.. include:: release-notes/release-notes-0.9.0.rst
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
ndn-cxx version 0.9.0
2+
---------------------
3+
4+
*Release date: July 28, 2024*
5+
6+
Important changes and new features
7+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8+
9+
- **C++17** is now *required* to build ndn-cxx and when including any of its header files
10+
11+
- The build dependencies have been increased as follows:
12+
13+
- GCC >= 9.3 or Clang >= 7.0 are strongly *recommended* on Linux; GCC 8.x is also known
14+
to work but is not officially supported
15+
- Xcode 13 or later is *recommended* on macOS; older versions may still work but are not
16+
officially supported
17+
- Boost >= 1.71.0 is *required* on all platforms
18+
19+
- Ubuntu 24.04 (Noble), Debian 12 (Bookworm), and macOS 14 (Sonoma) are now officially supported
20+
21+
- Added an official Dockerfile to the repository. From this Dockerfile, two images are currently
22+
published to the GitHub container registry:
23+
24+
- `named-data/ndn-cxx-build <https://github.com/named-data/ndn-cxx/pkgs/container/ndn-cxx-build>`__
25+
- `named-data/ndn-cxx-runtime <https://github.com/named-data/ndn-cxx/pkgs/container/ndn-cxx-runtime>`__
26+
27+
Both images are available for *linux/amd64* and *linux/arm64* platforms.
28+
29+
- The default forwarder socket path for Unix transports changed to ``/run/nfd/nfd.sock`` on Linux
30+
and to ``/var/run/nfd/nfd.sock`` on all other platforms (:issue:`5304`)
31+
32+
- On macOS, the default TPM backend is now **tpm-file** (the same as all other platforms)
33+
34+
- :ndn-cxx:`Interest::matchesData` no longer considers ``MustBeFresh`` and ``FreshnessPeriod``
35+
(:issue:`5270`)
36+
37+
- Modernized several APIs to use ``std::string_view``
38+
39+
- Added :ndn-cxx:`Interest::setApplicationParameters(std::string_view)` and
40+
:ndn-cxx:`Data::setContent(std::string_view)` overloads for convenience
41+
42+
- :ndn-cxx:`SegmentFetcher` gained an option to omit ``MustBeFresh`` from the first Interest sent
43+
44+
- Moved :ndn-cxx:`DummyClientFace`, :ndn-cxx:`Segmenter`, and :ndn-cxx:`SegmentFetcher` to
45+
namespace ``ndn``
46+
47+
- Moved all :ndn-cxx:`Signal`-related classes to namespace ``ndn::signal``
48+
49+
Improvements and bug fixes
50+
^^^^^^^^^^^^^^^^^^^^^^^^^^
51+
52+
- Check the TLV type when constructing :ndn-cxx:`Name` from :ndn-cxx:`Block`
53+
54+
- Provide relational operators for :ndn-cxx:`FaceUri`, to make it usable as a container key
55+
56+
- Generalize and simplify :ndn-cxx:`time::fromUnixTimestamp` and :ndn-cxx:`time::toUnixTimestamp`
57+
58+
- Prevent overflows in ``InterestLifetime`` and ``FreshnessPeriod`` (:issue:`4997`)
59+
60+
- Make HMAC signing and verification compatible with OpenSSL 3.x (:issue:`5251`)
61+
62+
- Better handling of large dates in :ndn-cxx:`ValidityPeriod` (:issue:`5176`)
63+
64+
- :ndn-cxx:`NetworkMonitor` now ignore AWDL interfaces on macOS (:issue:`5074`)
65+
66+
- Avoid dependency on *boost_program_options* when tools are disabled (:issue:`5210`)
67+
68+
- Add fine-grained options to ``./waf configure`` to enable/disable the compilation of
69+
benchmarks, integration tests, and unit tests independently
70+
71+
- Fix building the documentation with Python 3.12 (:issue:`5298`)
72+
73+
- Reduce amount of debugging information produced in compiled binaries by default (:issue:`5279`)
74+
75+
- Update waf build system to version 2.0.27
76+
77+
- Various code cleanups, modernizations, and documentation improvements
78+
79+
Deprecations
80+
^^^^^^^^^^^^
81+
82+
- ``Face::getIoService()``. Use ``Face::getIoContext()`` instead.
83+
84+
- ``Component::fromEscapedString()``. Use :ndn-cxx:`Component::fromUri` instead.
85+
86+
- TPM unlock and related functionality. This includes ``Tpm::isTpmLocked()``,
87+
``Tpm::unlockTpm()``, ``Tpm::isTerminalMode()``, ``Tpm::setTerminalMode()``,
88+
and the ``ndnsec-unlock-tpm`` command-line tool (:issue:`4754`)
89+
90+
Removals
91+
^^^^^^^^
92+
93+
- ``Block::wire()``. Use :ndn-cxx:`Block::data` instead.
94+
95+
- :ndn-cxx:`Component` constructors that take a raw ``const uint8_t*``. Use the ``span``-based
96+
constructors instead.
97+
98+
- ``Component::fromImplicitSha256Digest()`` and ``Component::fromParametersSha256Digest()``
99+
100+
- Previously deprecated overloads of ``Name::append()``
101+
102+
- ``Name::push_back()``. Use :ndn-cxx:`Name::append` instead.
103+
104+
- ``ndn::escape()`` and ``ndn::unescape()`` overloads that take raw strings as ``const char*`` +
105+
``size_t``. Use the corresponding ``std::string_view`` versions instead.
106+
107+
- ``ndn::optional`` and ``ndn::variant``. Use C++17 ``std::optional`` and ``std::variant``
108+
directly instead.
109+
110+
- ``ndn::to_string()``. Use the standard C++ function ``std::to_string()`` instead.
111+
112+
- Previously deprecated ``ndnsec`` command aliases (:issue:`5163`)

docs/releases.rst

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
All ndn-cxx Releases
2-
====================
1+
Release History
2+
===============
33

44
.. toctree::
55
:glob:
@@ -9,17 +9,26 @@ All ndn-cxx Releases
99

1010
release-notes/*
1111

12-
* **ndn-cxx version 0.8.1**
13-
(:doc:`Release Notes <release-notes/release-notes-0.8.1>`, `Documentation <https://docs.named-data.net/ndn-cxx/0.8.1/>`__)
12+
* **ndn-cxx version 0.9.0**
13+
\| :doc:`Release Notes <release-notes/release-notes-0.9.0>`
14+
\| `GitHub <https://github.com/named-data/ndn-cxx/releases/tag/ndn-cxx-0.9.0>`__
15+
\| `Source download <https://github.com/named-data/ndn-cxx/releases/download/ndn-cxx-0.9.0/ndn-cxx-0.9.0.tar.xz>`__
16+
(`checksum <https://github.com/named-data/ndn-cxx/releases/download/ndn-cxx-0.9.0/ndn-cxx-0.9.0.tar.xz.sha256>`__)
17+
\| `Documentation <https://docs.named-data.net/ndn-cxx/0.9.0/>`__
1418

15-
`src (git) <https://github.com/named-data/ndn-cxx/releases/tag/ndn-cxx-0.8.1>`__,
16-
`src (tarball) <https://named-data.net/downloads/ndn-cxx-0.8.1.tar.bz2>`__ (`checksum <https://named-data.net/downloads/ndn-cxx-0.8.1.tar.bz2.sha256>`__)
19+
* **ndn-cxx version 0.8.1**
20+
\| :doc:`Release Notes <release-notes/release-notes-0.8.1>`
21+
\| `GitHub <https://github.com/named-data/ndn-cxx/releases/tag/ndn-cxx-0.8.1>`__
22+
\| `Source download <https://named-data.net/downloads/ndn-cxx-0.8.1.tar.bz2>`__
23+
(`checksum <https://named-data.net/downloads/ndn-cxx-0.8.1.tar.bz2.sha256>`__)
24+
\| `Documentation <https://docs.named-data.net/ndn-cxx/0.8.1/>`__
1725

1826
* **ndn-cxx version 0.8.0**
19-
(:doc:`Release Notes <release-notes/release-notes-0.8.0>`, `Documentation <https://docs.named-data.net/ndn-cxx/0.8.0/>`__)
20-
21-
`src (git) <https://github.com/named-data/ndn-cxx/releases/tag/ndn-cxx-0.8.0>`__,
22-
`src (tarball) <https://named-data.net/downloads/ndn-cxx-0.8.0.tar.bz2>`__ (`checksum <https://named-data.net/downloads/ndn-cxx-0.8.0.tar.bz2.sha256>`__)
27+
\| :doc:`Release Notes <release-notes/release-notes-0.8.0>`
28+
\| `GitHub <https://github.com/named-data/ndn-cxx/releases/tag/ndn-cxx-0.8.0>`__
29+
\| `Source download <https://named-data.net/downloads/ndn-cxx-0.8.0.tar.bz2>`__
30+
(`checksum <https://named-data.net/downloads/ndn-cxx-0.8.0.tar.bz2.sha256>`__)
31+
\| `Documentation <https://docs.named-data.net/ndn-cxx/0.8.0/>`__
2332

2433
* **ndn-cxx version 0.7.1**
2534
(:doc:`Release Notes <release-notes/release-notes-0.7.1>`, `Documentation <https://docs.named-data.net/ndn-cxx/0.7.1/>`__)
@@ -72,13 +81,13 @@ All ndn-cxx Releases
7281
`src (tarball) <https://named-data.net/downloads/ndn-cxx-0.6.0.tar.bz2>`__ (`checksum <https://named-data.net/downloads/ndn-cxx-0.6.0.tar.bz2.sha256>`__)
7382

7483
* **ndn-cxx version 0.5.1**
75-
(:doc:`Release Notes <release-notes/release-notes-0.5.1>`, `Documentation <https://docs.named-data.net/ndn-cxx/0.5.1/>`__)
84+
(:doc:`Release Notes <release-notes/release-notes-0.5.1>`)
7685

7786
`src (git) <https://github.com/named-data/ndn-cxx/releases/tag/ndn-cxx-0.5.1>`__,
7887
`src (tarball) <https://named-data.net/downloads/ndn-cxx-0.5.1.tar.bz2>`__ (`checksum <https://named-data.net/downloads/ndn-cxx-0.5.1.tar.bz2.sha256>`__)
7988

8089
* **ndn-cxx version 0.5.0**
81-
(:doc:`Release Notes <release-notes/release-notes-0.5.0>`, `Documentation <https://docs.named-data.net/ndn-cxx/0.5.0/>`__)
90+
(:doc:`Release Notes <release-notes/release-notes-0.5.0>`)
8291

8392
`src (git) <https://github.com/named-data/ndn-cxx/releases/tag/ndn-cxx-0.5.0>`__,
8493
`src (tarball) <https://named-data.net/downloads/ndn-cxx-0.5.0.tar.bz2>`__ (`checksum <https://named-data.net/downloads/ndn-cxx-0.5.0.tar.bz2.sha256>`__)

wscript

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

7-
VERSION = '0.8.1'
7+
VERSION = '0.9.0'
88
APPNAME = 'ndn-cxx'
99
GIT_TAG_PREFIX = 'ndn-cxx-'
1010

0 commit comments

Comments
 (0)