Change default --json from 1 to latest

Jay Berkenbilt
1 parent fc1bfe4a
Showing 4 changed files with 13 additions and 6 deletions
ChangeLog
TODO
libqpdf/QPDFJob_config.cc
manual/release-notes.rst
 2022-04-16  Jay Berkenbilt  <ejb@ql.org>
+	* Breaking CLI change: the default value for --json is now
+	"latest" rather than "1". At this moment, "1" is the latest
+	version, but version "2" will be added before the release of
+	qpdf 11.
+
 	* Perform code cleanup including some source-compatible but not
 	binary compatible changes to function signatures.
@@ -6,7 +6,6 @@ Next
 * Stay on top of https://github.com/pikepdf/pikepdf/pull/315
 In order:
-* ABI including --json default is latest
 * json v2
 Other (do in any order):
@@ -480,7 +479,6 @@ This is a list of changes to make next time there is an ABI change.
 Comments appear in the code prefixed by "ABI"
 * Search for ABI to find items not listed here.
-* Switch default --json to latest
 * See where anonymous namespaces can be used to keep things private to
   a source file. Search for `(class|struct)` in **/*.cc.
 * After removing legacy QPDFNameTreeObjectHelper and
@@ -234,10 +234,7 @@ QPDFJob::Config::json()
 QPDFJob::Config*
 QPDFJob::Config::json(std::string const& parameter)
 {
-    if (parameter.empty()) {
-        // The default value is 1 for backward compatibility.
-        o.m->json_version = 1;
-    } else if (parameter == "latest") {
+    if (parameter.empty() || (parameter == "latest")) {
         o.m->json_version = 1;
     } else {
         o.m->json_version = QUtil::string_to_int(parameter.c_str());
@@ -57,6 +57,13 @@ For a detailed list of changes, please see the file
 	``autopkgtest`` framework but can be used by others. See
 	:file:`pkg-test/README.md` for details.
+  - CLI: breaking changes
+
+    - The default json output version when :qpdf:ref:`--json` is
+      specified has been changed from ``1`` to ``latest``.
+
+  - API: breaking changes
+
   - Other changes
     - A new chapter on contributing to qpdf has been added to the