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