Skip to content

Commit

Permalink
v0.7.1
Browse files Browse the repository at this point in the history
  • Loading branch information
biojppm committed Aug 15, 2024
1 parent e35b6dc commit 5ccf9a2
Show file tree
Hide file tree
Showing 16 changed files with 68 additions and 68 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ project(ryml
LANGUAGES CXX)
include(./compat.cmake)

c4_project(VERSION 0.7.0 STANDALONE
c4_project(VERSION 0.7.1 STANDALONE
AUTHOR "Joao Paulo Magalhaes <[email protected]>")


Expand Down
35 changes: 35 additions & 0 deletions changelog/0.7.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## New features

- [PR#459](https://github.com/biojppm/rapidyaml/pull/459): Add version functions and macros:
```cpp
#define RYML_VERSION "0.7.1"
#define RYML_VERSION_MAJOR 0
#define RYML_VERSION_MINOR 7
#define RYML_VERSION_PATCH 1
csubstr version();
int version_major();
int version_minor();
int version_patch();
```
## Fixes
- Fix [#455](https://github.com/biojppm/rapidyaml/issues/455): parsing of trailing val-less nested maps when deindented to maps ([PR#460](https://github.com/biojppm/rapidyaml/pull/460))
- Fix filtering of double-quoted keys in block maps ([PR#452](https://github.com/biojppm/rapidyaml/pull/452))
- Fix [#440](https://github.com/biojppm/rapidyaml/issues/440): some tests failing with gcc -O2 (hypothetically due to undefined behavior)
- This was accomplished by refactoring some internal parser functions; see the comments in [#440](https://github.com/biojppm/rapidyaml/issues/440) for further details.
- Also, fix all warnings from `scan-build`.
- Use malloc.h instead of alloca.h on MinGW ([PR#447](https://github.com/biojppm/rapidyaml/pull/447))
- Fix [#442](https://github.com/biojppm/rapidyaml/issues/442) ([PR#443](https://github.com/biojppm/rapidyaml/pull/443)):
- Ensure leading `+` is accepted when deserializing numbers.
- Ensure numbers are not quoted by fixing the heuristics in `scalar_style_query_plain()` and `scalar_style_choose()`.
- Add quickstart sample for overflow detection (only of integral types).
- Parse engine: cleanup unused macros
## Thanks
- @marcalff
- @toge
- @musicinmybrain
- @buty4649
35 changes: 0 additions & 35 deletions changelog/current.md
Original file line number Diff line number Diff line change
@@ -1,35 +0,0 @@
## New features

- [PR#459](https://github.com/biojppm/rapidyaml/pull/459): Add version functions and macros:
```cpp
#define RYML_VERSION "0.7.1"
#define RYML_VERSION_MAJOR 0
#define RYML_VERSION_MINOR 7
#define RYML_VERSION_PATCH 1
csubstr version();
int version_major();
int version_minor();
int version_patch();
```
## Fixes
- Fix [#455](https://github.com/biojppm/rapidyaml/issues/455): parsing of trailing val-less nested maps when deindented to maps ([PR#460](https://github.com/biojppm/rapidyaml/pull/460))
- Fix filtering of double-quoted keys in block maps ([PR#452](https://github.com/biojppm/rapidyaml/pull/452))
- Fix [#440](https://github.com/biojppm/rapidyaml/issues/440): some tests failing with gcc -O2 (hypothetically due to undefined behavior)
- This was accomplished by refactoring some internal parser functions; see the comments in [#440](https://github.com/biojppm/rapidyaml/issues/440) for further details.
- Also, fix all warnings from `scan-build`.
- Use malloc.h instead of alloca.h on MinGW ([PR#447](https://github.com/biojppm/rapidyaml/pull/447))
- Fix [#442](https://github.com/biojppm/rapidyaml/issues/442) ([PR#443](https://github.com/biojppm/rapidyaml/pull/443)):
- Ensure leading `+` is accepted when deserializing numbers.
- Ensure numbers are not quoted by fixing the heuristics in `scalar_style_query_plain()` and `scalar_style_choose()`.
- Add quickstart sample for overflow detection (only of integral types).
- Parse engine: cleanup unused macros
## Thanks
- @marcalff
- @toge
- @musicinmybrain
- @buty4649
2 changes: 1 addition & 1 deletion doc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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.0
PROJECT_NUMBER = 0.7.1

# 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
Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
project = 'rapidyaml'
copyright = '2018-2024 Joao Paulo Magalhaes <[email protected]>'
author = 'Joao Paulo Magalhaes <[email protected]>'
release = '0.7.0'
release = '0.7.1'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
2 changes: 1 addition & 1 deletion doc/doxy_main.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# rapidyaml

* Begin by looking at the [project's README](https://github.com/biojppm/rapidyaml/blob/v0.7.0/README.md)
* Begin by looking at the [project's README](https://github.com/biojppm/rapidyaml/blob/v0.7.1/README.md)
* [Documentation page](https://rapidyaml.readthedocs.org)
* Next, skim the docs for the @ref doc_quickstart sample.
* Good! Now the main ryml topics:
Expand Down
18 changes: 9 additions & 9 deletions doc/sphinx_is_it_rapid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.0/bm/cases>`__, or
<https://github.com/biojppm/rapidyaml/blob/v0.7.1/bm/cases>`__, or
just send us the files.

`Here’s a parsing benchmark
<https://github.com/biojppm/rapidyaml/blob/v0.7.0/bm/bm_parse.cpp>`__. Using
<https://github.com/biojppm/rapidyaml/blob/v0.7.1/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.
Expand All @@ -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.0/bm/cases/appveyor.yml>`__. A
<https://github.com/biojppm/rapidyaml/blob/v0.7.1/bm/cases/appveyor.yml>`__. A
comparison of these results is summarized on the table below:

=========================== ===== ======= ==========
Expand All @@ -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.0/bm/cases/travis.yml>`__
<https://github.com/biojppm/rapidyaml/blob/v0.7.1/bm/cases/travis.yml>`__
or a JSON buffer from a `compile_commands.json file
<https://github.com/biojppm/rapidyaml/blob/v0.7.0/bm/cases/compile_commands.json>`__. You
<https://github.com/biojppm/rapidyaml/blob/v0.7.1/bm/cases/compile_commands.json>`__. You
can `see the full results here
<https://github.com/biojppm/rapidyaml/blob/v0.7.0/bm/results/parse.linux.i7_6800K.md>`__. Summarizing:
<https://github.com/biojppm/rapidyaml/blob/v0.7.1/bm/results/parse.linux.i7_6800K.md>`__. Summarizing:

========================== ===== ======= ========
Read rates (MB/s) ryml yamlcpp compared
Expand Down Expand Up @@ -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.0/bm/bm_parse.cpp>`__,
<https://github.com/biojppm/rapidyaml/blob/v0.7.1/bm/bm_parse.cpp>`__,
and it is reading the `compile_commands.json
<https://github.com/biojppm/rapidyaml/blob/v0.7.0/bm/cases/compile_commands.json>`__,
<https://github.com/biojppm/rapidyaml/blob/v0.7.1/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
Expand Down Expand Up @@ -131,7 +131,7 @@ Performance emitting
--------------------

`Emitting benchmarks
<https://github.com/biojppm/rapidyaml/blob/v0.7.0/bm/bm_emit.cpp>`__
<https://github.com/biojppm/rapidyaml/blob/v0.7.1/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)
Expand Down
6 changes: 3 additions & 3 deletions doc/sphinx_quicklinks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ Quick links

* `Kanban board <https://github.com/users/biojppm/projects/1/views/1>`_

* Latest release: `0.7.0 <https://github.com/biojppm/rapidyaml/releases/tag/v0.7.0>`_
* Latest release: `0.7.1 <https://github.com/biojppm/rapidyaml/releases/tag/v0.7.1>`_

* `Release page [0.7.0] <https://github.com/biojppm/rapidyaml/releases/tag/v0.7.0>`_
* `Release page [0.7.1] <https://github.com/biojppm/rapidyaml/releases/tag/v0.7.1>`_

* `README [0.7.0] <https://github.com/biojppm/rapidyaml/blob/v0.7.0/README.md>`_
* `README [0.7.1] <https://github.com/biojppm/rapidyaml/blob/v0.7.1/README.md>`_

* Since latest release (master branch):

Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx_try_quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
include(FetchContent)
FetchContent_Declare(ryml
GIT_REPOSITORY https://github.com/biojppm/rapidyaml.git
GIT_TAG v0.7.0
GIT_TAG v0.7.1
GIT_SHALLOW FALSE # ensure submodules are checked out
)
FetchContent_MakeAvailable(ryml)
Expand Down
18 changes: 9 additions & 9 deletions doc/sphinx_using.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Quickstart build samples

These samples show different ways of getting ryml into your application.
All the samples use `the same quickstart executable
source <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/quickstart.cpp>`__, but are built in different ways,
source <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/quickstart.cpp>`__, but are built in different ways,
showing several alternatives to integrate ryml into your project. We
also encourage you to refer to the `quickstart
docs <doxygen/group__doc__quickstart.html>`__, which extensively cover
Expand All @@ -29,19 +29,19 @@ more about each sample:
+-------------------------------------------------------------------------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| Sample name | ryml is part of build? | cmake file | commands |
+=================================================================================================+==================================+==============================================================================================================+=============================================================================================================+
| `singleheader <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/singleheader>`_ | | **yes** | `CMakeLists.txt <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/singleheader/CMakeLists.txt>`_ | `run.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/singleheader/run.sh>`_ |
| `singleheader <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/singleheader>`_ | | **yes** | `CMakeLists.txt <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/singleheader/CMakeLists.txt>`_ | `run.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/singleheader/run.sh>`_ |
| | | ryml brought as a single | | |
| | | header, not as a library | | |
+-------------------------------------------------------------------------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| `singleheaderlib <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/singleheaderlib>`_ | | **yes** | `CMakeLists.txt <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/singleheaderlib/CMakeLists.txt>`_ | | `run_shared.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/singleheaderlib/run_shared.sh>`_ |
| | | ryml brought as library | | | `run_static.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/singleheaderlib/run_static.sh>`_ |
| `singleheaderlib <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/singleheaderlib>`_ | | **yes** | `CMakeLists.txt <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/singleheaderlib/CMakeLists.txt>`_ | | `run_shared.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/singleheaderlib/run_shared.sh>`_ |
| | | ryml brought as library | | | `run_static.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/singleheaderlib/run_static.sh>`_ |
| | | but from the single header | | |
+-------------------------------------------------------------------------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| `add_subdirectory <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/add_subdirectory>`_ | **yes** | `CMakeLists.txt <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/add_subdirectory/CMakeLists.txt>`_ | `run.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/add_subdirectory/run.sh>`_ |
| `add_subdirectory <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/add_subdirectory>`_ | **yes** | `CMakeLists.txt <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/add_subdirectory/CMakeLists.txt>`_ | `run.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/add_subdirectory/run.sh>`_ |
+-------------------------------------------------------------------------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| `fetch_content <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/fetch_content>`_ | **yes** | `CMakeLists.txt <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/fetch_content/CMakeLists.txt>`_ | `run.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/fetch_content/run.sh>`_ |
| `fetch_content <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/fetch_content>`_ | **yes** | `CMakeLists.txt <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/fetch_content/CMakeLists.txt>`_ | `run.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/fetch_content/run.sh>`_ |
+-------------------------------------------------------------------------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| `find_package <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/find_package>`_ | | **no** | `CMakeLists.txt <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/find_package/CMakeLists.txt>`_ | `run.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/find_package/run.sh>`_ |
| `find_package <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/find_package>`_ | | **no** | `CMakeLists.txt <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/find_package/CMakeLists.txt>`_ | `run.sh <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/find_package/run.sh>`_ |
| | | needs prior install or package | | |
+-------------------------------------------------------------------------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+

Expand All @@ -51,7 +51,7 @@ As a single-header

ryml is provided chiefly as a cmake library project, but it can also
be used as a single header file, and there is a `tool to amalgamate
<https://github.com/biojppm/rapidyaml/blob/v0.7.0/tools/amalgamate.py>`__
<https://github.com/biojppm/rapidyaml/blob/v0.7.1/tools/amalgamate.py>`__
the code into a single header file. The amalgamated header file is
provided with each release, but you can also generate a customized
file suiting your particular needs (or commit):
Expand Down Expand Up @@ -185,7 +185,7 @@ that c4core is a submodule of the current repo. However, it is still
possible to use a c4core version different from the one in the repo (of
course, only if there are no incompatibilities between the versions).
You can find out how to achieve this by looking at the
`custom_c4core sample <https://github.com/biojppm/rapidyaml/blob/v0.7.0/samples/custom_c4core/CMakeLists.txt>`__.
`custom_c4core sample <https://github.com/biojppm/rapidyaml/blob/v0.7.1/samples/custom_c4core/CMakeLists.txt>`__.


CMake build settings for ryml
Expand Down
2 changes: 1 addition & 1 deletion samples/quickstart.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ namespace sample {
* include(FetchContent)
* FetchContent_Declare(ryml
* GIT_REPOSITORY https://github.com/biojppm/rapidyaml.git
* GIT_TAG v0.7.0
* GIT_TAG v0.7.1
* GIT_SHALLOW FALSE # ensure submodules are checked out
* )
* FetchContent_MakeAvailable(ryml)
Expand Down
4 changes: 2 additions & 2 deletions src/c4/yml/version.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@

/** @file version.hpp */

#define RYML_VERSION "0.7.0"
#define RYML_VERSION "0.7.1"
#define RYML_VERSION_MAJOR 0
#define RYML_VERSION_MINOR 7
#define RYML_VERSION_PATCH 0
#define RYML_VERSION_PATCH 1

#include <c4/substr.hpp>
#include <c4/yml/export.hpp>
Expand Down
2 changes: 1 addition & 1 deletion tbump.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
github_url = "https://github.com/biojppm/rapidyaml/"

[version]
current = "0.7.0"
current = "0.7.1"

# Example of a semver regexp.
# Make sure this matches current_version before
Expand Down
2 changes: 1 addition & 1 deletion test/test_install/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ project(ryml
HOMEPAGE_URL "https://github.com/biojppm/rapidyaml"
LANGUAGES CXX)
include(../../ext/c4core/cmake/c4Project.cmake)
c4_project(VERSION 0.7.0
c4_project(VERSION 0.7.1
AUTHOR "Joao Paulo Magalhaes <[email protected]>")


Expand Down
Loading

0 comments on commit 5ccf9a2

Please sign in to comment.