Emphasize --deterministic-id over --static-id in idempotency doc

Jay Berkenbilt
1 parent 0f97e982
Showing 3 changed files with 9 additions and 10 deletions
TODO
job.sums
manual/cli.rst
@@ -12,8 +12,6 @@ Always
 * Fix #874 -- make args in --encrypt to match the json and make
   positional fill in the gaps
 * Maybe fix #553 -- use file times for attachments
-* Clarify idempotency section to emphasize --deterministic-id over
-  --static-id
  
 Next
 ====
@@ -14,4 +14,4 @@ libqpdf/qpdf/auto_job_json_decl.hh 06caa46eaf71db8a50c046f91866baa8087745a947431
 libqpdf/qpdf/auto_job_json_init.hh 85ac7e5c66f14c767419823eac84bdea4bd72d690bfe12b533321e5708e644b7
 libqpdf/qpdf/auto_job_schema.hh 5e0f5cb7d462716fe52548b2ae1a8eb6f3c900016e915140eea37f78cee45b2b
 manual/_ext/qpdf.py 6add6321666031d55ed4aedf7c00e5662bba856dfcd66ccb526563bffefbb580
-manual/cli.rst 255db0c62765b39de9a71d3d755479235f5bbce32f2902ec5e0e201f265e322d
+manual/cli.rst ab2b2feb3217151a7a7f67b1774bd7fb704d94a325282e691ea1fd0a7cbf11f0
@@ -3397,20 +3397,21 @@ random element, as well as the interaction of stream length encoding
 with dictionary key sorting.
  
 It is possible to get idempotent behavior by using the
-:qpdf:ref:`--static-id` or :qpdf:ref:`--deterministic-id` option with
-qpdf and running it *three* times so that you are processing the
-output of qpdf on its own previous output. For example, in this
-sequence of commands:
+:qpdf:ref:`--deterministic-id` (or, for testing only,
+:qpdf:ref:`--static-id`) option with qpdf and running it *three* times
+so that you are processing the output of qpdf on its own previous
+output. For example, in this sequence of commands:
  
 ::
  
    qpdf any-file.pdf 1.pdf
-   qpdf --static-id 1.pdf 2.pdf
-   qpdf --static-id 2.pdf 3.pdf
+   qpdf --deterministic-id 1.pdf 2.pdf
+   qpdf --deterministic-id 2.pdf 3.pdf
  
 the files :file:`2.pdf` and :file:`3.pdf` should be *byte-for-byte*
 identical. The qpdf test suite relies on this behavior. See also
-:qpdf:ref:`--static-aes-iv`.
+:qpdf:ref:`--static-aes-iv`, which should also be used only for
+testing.
  
 Related Options
 ~~~~~~~~~~~~~~~