aboutsummaryrefslogtreecommitdiffstats
path: root/README-maintainer
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2022-01-25 17:21:02 +0100
committerJay Berkenbilt <ejb@ql.org>2022-01-30 19:11:03 +0100
commitf729a336f719304871045d4b98b32907a6713f4d (patch)
treef17819e3ef42b701ca14a787002b0f74c97b3172 /README-maintainer
parentbf255ccc896dc9cf54b13e0f60371f7429035b50 (diff)
downloadqpdf-f729a336f719304871045d4b98b32907a6713f4d.tar.zst
TODO: doc reminder
Diffstat (limited to 'README-maintainer')
-rw-r--r--README-maintainer6
1 files changed, 6 insertions, 0 deletions
diff --git a/README-maintainer b/README-maintainer
index 7ea049dc..b08cada2 100644
--- a/README-maintainer
+++ b/README-maintainer
@@ -124,6 +124,12 @@ CODING RULES
HOW TO ADD A COMMAND-LINE ARGUMENT
+QXXXQ update this to explain about all the automatic handlers, the
+difference between config, json, and argv, option tables, json
+dictionaries, etc. Make sure everthing that generate_auto_job does and
+its interaction with all the QPDFJob* source/header files is clearly
+explained.
+
Command-line arguments are closely coupled with QPDFJob. To add a new
command-line argument, add the option to the appropriate table in
job.yml. This will automatically declare a method in the private