Commit e6b6ca466a81c878aaeab3a022ff965f044e0e86
1 parent
08e3050d
Update docs on adding a command-line argument
Showing
1 changed file
with
8 additions
and
1 deletions
README-maintainer.md
| @@ -377,7 +377,8 @@ Quick reminder: | @@ -377,7 +377,8 @@ Quick reminder: | ||
| 377 | argument | 377 | argument |
| 378 | * Add an entry to the bottom half of job.yml for the job JSON field | 378 | * Add an entry to the bottom half of job.yml for the job JSON field |
| 379 | * Add documentation for the new option to cli.rst | 379 | * Add documentation for the new option to cli.rst |
| 380 | -* Implement the QPDFJob::Config method in QPDFJob_config.cc. | 380 | +* Implement the QPDFJob::Config method in QPDFJob_config.cc |
| 381 | +* Adding new options tables is harder -- see below | ||
| 381 | 382 | ||
| 382 | QPDFJob is documented in three places: | 383 | QPDFJob is documented in three places: |
| 383 | 384 | ||
| @@ -406,6 +407,12 @@ you need a manual handler, you have to declare the option as manual in | @@ -406,6 +407,12 @@ you need a manual handler, you have to declare the option as manual in | ||
| 406 | job.yml and implement the handler yourself, though the automatically | 407 | job.yml and implement the handler yourself, though the automatically |
| 407 | generated code will declare it for you. | 408 | generated code will declare it for you. |
| 408 | 409 | ||
| 410 | +Adding a new option table is a bit harder and is not well-documented. | ||
| 411 | +For a simple example, look at the code that added the | ||
| 412 | +--set-page-labels table. That change was divided into two commits (one | ||
| 413 | +for the manual changes, and one for the generated changes) to make it | ||
| 414 | +easier to use as an example. | ||
| 415 | + | ||
| 409 | The build will fail until the new option is documented in | 416 | The build will fail until the new option is documented in |
| 410 | manual/cli.rst. To do that, create documentation for the option by | 417 | manual/cli.rst. To do that, create documentation for the option by |
| 411 | adding a ".. qpdf:option::" directive followed by a magic help comment | 418 | adding a ".. qpdf:option::" directive followed by a magic help comment |