diff options
author | Jay Berkenbilt <ejb@ql.org> | 2024-01-05 18:21:38 +0100 |
---|---|---|
committer | Jay Berkenbilt <ejb@ql.org> | 2024-01-05 23:10:47 +0100 |
commit | e6b6ca466a81c878aaeab3a022ff965f044e0e86 (patch) | |
tree | fdb39b4482c4ae63c9b1e4d59735e338199fdf76 /README-maintainer.md | |
parent | 08e3050d5f1608d744daafb8b6b39fe6ccea65ed (diff) | |
download | qpdf-e6b6ca466a81c878aaeab3a022ff965f044e0e86.tar.zst |
Update docs on adding a command-line argument
Diffstat (limited to 'README-maintainer.md')
-rw-r--r-- | README-maintainer.md | 9 |
1 files changed, 8 insertions, 1 deletions
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 |