v0.8.0

Author: biojppm

CMakeLists.txt

@@ -6,7 +6,7 @@ project(ryml
     LANGUAGES CXX)
 include(./compat.cmake)
 
-c4_project(VERSION 0.7.2 STANDALONE
+c4_project(VERSION 0.8.0 STANDALONE
     AUTHOR "Joao Paulo Magalhaes <dev@jpmag.me>")
 
 

changelog/0.8.0.md

@@ -0,0 +1,43 @@
+## Breaking changes
+
+- [BREAKING] Fix [#480](https://github.com/biojppm/rapidyaml/issues/480) ([PR#489](https://github.com/biojppm/rapidyaml/pull/489)):
+  - Deserializing an empty quoted string *will not* cause an error.
+  - Deserializing an empty string *will* cause an error: the empty string is read in as an empty scalar.
+  - Ensure keys are deserialized using all the rules applying to vals.
+  - Added `KEYNIL` and `VALNIL` to `NodeType_e`, used by the parser to mark the key or val as empty. This changed the values of the `NodeType_e` enumeration.
+  - Added `NodeType::key_is_null()` and `NodeType::val_is_null()`.
+- [BREAKING] Fix [#477](https://github.com/biojppm/rapidyaml/issues/477) ([PR#479](https://github.com/biojppm/rapidyaml/pull/479)): changed `read<std::map>()` to overwrite existing entries. The provided implementations had an inconsistency between `std::map` (which wasn't overwriting) and `std::vector` (which *was* overwriting).
+
+
+## Fixes
+
+- [PR#488](https://github.com/biojppm/rapidyaml/pull/488):
+  - add workarounds for problems with codegen of gcc 11,12,13.
+  - improve CI coverage of gcc and clang optimization levels.
+- [PR#496](https://github.com/biojppm/rapidyaml/pull/496) and [c4core PR#148](https://github.com/biojppm/c4core/pull/148): Add CI-proven support for CPU architectures:
+  - mips, mipsel, mips64, mips64el
+  - sparc, sparc64
+  - riscv64
+  - loongarch64
+- Fix [#476](https://github.com/biojppm/rapidyaml/issues/476) ([PR#493](https://github.com/biojppm/rapidyaml/pull/493)): add handling of Byte Order Marks.
+- [PR#492](https://github.com/biojppm/rapidyaml/pull/492): fix emit of explicit keys when indented:
+  ```yaml
+  fixed:
+      ? explicit key
+      : value
+  previously:
+      ? explicit key
+  : value   # this was not indented
+  ```
+- [PR#492](https://github.com/biojppm/rapidyaml/pull/492): fix parser reset for full reuse (`m_doc_empty` was not resetted), which would cause problems under specific scenarios in subsequent reuse.
+- [PR#485](https://github.com/biojppm/rapidyaml/pull/485): improve the CI workflows (thanks to @ingydotnet):
+  - amazing code reuse and organization, thanks to the use of YamlScript to generate the final workflows
+  - all optimization levels are now covered for gcc, clang and Visual Studio.
+- [PR#499](https://github.com/biojppm/rapidyaml/pull/499): fix warnings with `-Wundef`.
+
+
+## Thanks
+
+- @ingydotnet
+- @perlpunk
+- @Delian0

changelog/current.md

@@ -1,39 +0,0 @@
-## Fixes
-
-- [PR#496](https://github.com/biojppm/rapidyaml/pull/496) and [c4core PR#148](https://github.com/biojppm/c4core/pull/148): Add CI-proven support for CPU architectures:
-  - mips, mipsel, mips64, mips64el
-  - sparc, sparc64
-  - riscv64
-  - loongarch64
-- Fix [#480](https://github.com/biojppm/rapidyaml/issues/480) ([PR#489](https://github.com/biojppm/rapidyaml/pull/489)):
-  - Deserializing an empty quoted string *will not* cause an error.
-  - Deserializing an empty string *will* cause an error.
-  - Ensure keys are deserialized using all the rules applying to vals.
-  - Added `KEYNIL` and `VALNIL` to `NodeType_e`, used by the parser to mark the key or val as empty. This changed the values of the `NodeType_e` enumeration.
-  - Added `NodeType::key_is_null()` and `NodeType::val_is_null()`.
-- [PR#488](https://github.com/biojppm/rapidyaml/pull/488):
-  - add workarounds for problems with codegen of gcc 11,12,13.
-  - improve CI coverage of gcc and clang optimization levels.
-- [BREAKING] Fix [#477](https://github.com/biojppm/rapidyaml/issues/477) ([PR#479](https://github.com/biojppm/rapidyaml/pull/479)): changed `read<std::map>()` to overwrite existing entries. The provided implementations had an inconsistency between `std::map` (which wasn't overwriting) and `std::vector` (which *was* overwriting).
-- Fix [#476](https://github.com/biojppm/rapidyaml/issues/476) [PR#493](https://github.com/biojppm/rapidyaml/pull/493): add handling of Byte Order Marks.
-- [PR#492](https://github.com/biojppm/rapidyaml/pull/492): fix emit of explicit keys when indented:
-  ```yaml
-  fixed:
-      ? explicit key
-      : value
-  previously:
-      ? explicit key
-  : value   # this was not indented
-  ```
-- [PR#492](https://github.com/biojppm/rapidyaml/pull/492): fix parser reset for full reuse (`m_doc_empty` was not resetted), which would cause problems under specific scenarios in subsequent reuse.
-- [PR#485](https://github.com/biojppm/rapidyaml/pull/485): improve the CI workflows (thanks to @ingydotnet):
-  - amazing code reuse and organization, thanks to the use of YamlScript to generate the final workflows
-  - all optimization levels are now covered for gcc, clang and Visual Studio.
-- [PR#499](https://github.com/biojppm/rapidyaml/pull/499): fix warnings with `-Wundef`.
-
-
-## Thanks
-
-- @ingydotnet
-- @Delian0
-- @perlpunk

doc/Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = rapidyaml
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.7.2
+PROJECT_NUMBER         = 0.8.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

doc/conf.py

@@ -10,7 +10,7 @@
 project = 'rapidyaml'
 copyright = '2018-2024 Joao Paulo Magalhaes <dev@jpmag.me>'
 author = 'Joao Paulo Magalhaes <dev@jpmag.me>'
-release = '0.7.2'
+release = '0.8.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

doc/doxy_main.md

@@ -1,6 +1,6 @@
 # rapidyaml
 
-* Begin by looking at the [project's README](https://github.com/biojppm/rapidyaml/blob/v0.7.2/README.md)
+* Begin by looking at the [project's README](https://github.com/biojppm/rapidyaml/blob/v0.8.0/README.md)
 * [Documentation page](https://rapidyaml.readthedocs.org)
 * Next, skim the docs for the @ref doc_quickstart sample.
 * Good! Now the main ryml topics:

doc/index.rst

@@ -72,7 +72,7 @@ API teaser
 Here's a short teaser from the API quickstart overview (`see on
 doxygen <doxygen/group__doc__quickstart.html>`_ / `see full code on
 github
-<https://github.com/biojppm/rapidyaml/blob/v0.7.2/samples/quickstart.cpp>`_):
+<https://github.com/biojppm/rapidyaml/blob/v0.8.0/samples/quickstart.cpp>`_):
 
 .. code-block:: c++
 

doc/sphinx_is_it_rapid.rst

@@ -25,11 +25,11 @@ faster.
    nicely as claimed here, we would definitely like to see it! Please
    open an issue, or submit a pull request adding the file to
    `bm/cases
-   <https://github.com/biojppm/rapidyaml/blob/v0.7.2/bm/cases>`__, or
+   <https://github.com/biojppm/rapidyaml/blob/v0.8.0/bm/cases>`__, or
    just send us the files.
 
 `Here’s a parsing benchmark
-<https://github.com/biojppm/rapidyaml/blob/v0.7.2/bm/bm_parse.cpp>`__. Using
+<https://github.com/biojppm/rapidyaml/blob/v0.8.0/bm/bm_parse.cpp>`__. Using
 different approaches within ryml (in-situ/read-only vs. with/without
 reuse), a YAML / JSON buffer is repeatedly parsed, and compared
 against other libraries.
@@ -40,7 +40,7 @@ Comparison with yaml-cpp
 
 The first result set is for Windows, and is using a `appveyor.yml
 config file
-<https://github.com/biojppm/rapidyaml/blob/v0.7.2/bm/cases/appveyor.yml>`__. A
+<https://github.com/biojppm/rapidyaml/blob/v0.8.0/bm/cases/appveyor.yml>`__. A
 comparison of these results is summarized on the table below:
 
 =========================== ===== ======= ==========
@@ -52,11 +52,11 @@ appveyor / vs2017 / Debug   6.4   0.0844  76x / 1.3%
 
 The next set of results is taken in Linux, comparing g++ 8.2 and
 clang++ 7.0.1 in parsing a YAML buffer from a `travis.yml config file
-<https://github.com/biojppm/rapidyaml/blob/v0.7.2/bm/cases/travis.yml>`__
+<https://github.com/biojppm/rapidyaml/blob/v0.8.0/bm/cases/travis.yml>`__
 or a JSON buffer from a `compile_commands.json file
-<https://github.com/biojppm/rapidyaml/blob/v0.7.2/bm/cases/compile_commands.json>`__. You
+<https://github.com/biojppm/rapidyaml/blob/v0.8.0/bm/cases/compile_commands.json>`__. You
 can `see the full results here
-<https://github.com/biojppm/rapidyaml/blob/v0.7.2/bm/results/parse.linux.i7_6800K.md>`__. Summarizing:
+<https://github.com/biojppm/rapidyaml/blob/v0.8.0/bm/results/parse.linux.i7_6800K.md>`__. Summarizing:
 
 ========================== ===== ======= ========
 Read rates (MB/s)          ryml  yamlcpp compared
@@ -89,9 +89,9 @@ So how does ryml compare against other JSON readers? Well, it may not
 be the fastest, but it's definitely ahead of the pack!
 
 The benchmark is the `same as above
-<https://github.com/biojppm/rapidyaml/blob/v0.7.2/bm/bm_parse.cpp>`__,
+<https://github.com/biojppm/rapidyaml/blob/v0.8.0/bm/bm_parse.cpp>`__,
 and it is reading the `compile_commands.json
-<https://github.com/biojppm/rapidyaml/blob/v0.7.2/bm/cases/compile_commands.json>`__,
+<https://github.com/biojppm/rapidyaml/blob/v0.8.0/bm/cases/compile_commands.json>`__,
 The ``_arena`` suffix notes parsing a read-only buffer (so buffer
 copies are performed), while the ``_inplace`` suffix means that the
 source buffer can be parsed in place. The ``_reuse`` means the data
@@ -131,7 +131,7 @@ Performance emitting
 --------------------
 
 `Emitting benchmarks
-<https://github.com/biojppm/rapidyaml/blob/v0.7.2/bm/bm_emit.cpp>`__
+<https://github.com/biojppm/rapidyaml/blob/v0.8.0/bm/bm_emit.cpp>`__
 also show similar speedups from the existing libraries, also
 anecdotally reported by some users `(eg, here’s a user reporting 25x
 speedup from yaml-cpp)

doc/sphinx_quicklinks.rst

@@ -15,11 +15,11 @@ Quick links
 
   * `Kanban board <https://github.com/users/biojppm/projects/1/views/1>`_
 
-* Latest release: `0.7.2 <https://github.com/biojppm/rapidyaml/releases/tag/v0.7.2>`_
+* Latest release: `0.8.0 <https://github.com/biojppm/rapidyaml/releases/tag/v0.8.0>`_
 
-  * `Release page [0.7.2] <https://github.com/biojppm/rapidyaml/releases/tag/v0.7.2>`_
+  * `Release page [0.8.0] <https://github.com/biojppm/rapidyaml/releases/tag/v0.8.0>`_
 
-  * `README [0.7.2] <https://github.com/biojppm/rapidyaml/blob/v0.7.2/README.md>`_
+  * `README [0.8.0] <https://github.com/biojppm/rapidyaml/blob/v0.8.0/README.md>`_
 
 * Since latest release (master branch):
 

doc/sphinx_try_quickstart.rst

@@ -11,7 +11,7 @@
       include(FetchContent)
       FetchContent_Declare(ryml
           GIT_REPOSITORY https://github.com/biojppm/rapidyaml.git
-          GIT_TAG v0.7.2
+          GIT_TAG v0.8.0
           GIT_SHALLOW FALSE  # ensure submodules are checked out
       )
       FetchContent_MakeAvailable(ryml)