From e6b6ca466a81c878aaeab3a022ff965f044e0e86 Mon Sep 17 00:00:00 2001 From: Jay Berkenbilt Date: Fri, 5 Jan 2024 12:21:38 -0500 Subject: Update docs on adding a command-line argument --- README-maintainer.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'README-maintainer.md') diff --git a/README-maintainer.md b/README-maintainer.md index a248918b..e6a5d9b8 100644 --- a/README-maintainer.md +++ b/README-maintainer.md @@ -377,7 +377,8 @@ Quick reminder: argument * Add an entry to the bottom half of job.yml for the job JSON field * Add documentation for the new option to cli.rst -* Implement the QPDFJob::Config method in QPDFJob_config.cc. +* Implement the QPDFJob::Config method in QPDFJob_config.cc +* Adding new options tables is harder -- see below QPDFJob is documented in three places: @@ -406,6 +407,12 @@ you need a manual handler, you have to declare the option as manual in job.yml and implement the handler yourself, though the automatically generated code will declare it for you. +Adding a new option table is a bit harder and is not well-documented. +For a simple example, look at the code that added the +--set-page-labels table. That change was divided into two commits (one +for the manual changes, and one for the generated changes) to make it +easier to use as an example. + The build will fail until the new option is documented in manual/cli.rst. To do that, create documentation for the option by adding a ".. qpdf:option::" directive followed by a magic help comment -- cgit v1.2.3-54-g00ecf