Document the macros that preview version 4.0 in the roadmap (#5593)

* Document the macros that preview version 4.0 in the roadmap

List the macros that guard breaking changes planned to become the
default in version 4.0.0, and explain that 4.0.0 will be the sum of
these opt-in flags, which can be tried on the 3.x release train.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

* List the deprecated functions removed in 4.0 in the roadmap

The roadmap lists what will be removed; the migration guide keeps the
examples for how to replace each item. Also mention the deprecated
(ptr, len) overloads of the from_* functions in the migration guide.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

* Wrap overlong line in cbor_tag_handler_t documentation

The line added in #5559 exceeds the 160-character limit enforced by the
documentation style check.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

* Add JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON to the 4.0 example

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

* Add JSON_STRICT_BINARY_UTF8 to the 4.0 roadmap

The macro comes from #5741: the CBOR, UBJSON, BJData, and BSON writers keep writing ill-formed UTF-8 unchanged in 3.x and are planned to check it by default in 4.0.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

---------

Signed-off-by: Niels Lohmann <mail@nlohmann.me>
This commit is contained in:
Niels Lohmann
2026-10-04 11:59:34 +02:00
committed by GitHub
parent c5650eaa3c
commit 1a77948c25
3 changed files with 71 additions and 7 deletions

View File

@@ -115,3 +115,4 @@ The default value is `0` (disabled — existing behavior is preserved).
## Version history
- Added in version 3.13.0.
- Planned to become the default (with the macro removed) in version 4.0.0.