[Git][reproducible-builds/diffoscope][master] Improve documentation for --timeout due to a few misconceptions.

[Chris Lamb (@lamby)]

Chris Lamb pushed to branch master at Reproducible Builds / diffoscope


Commits:
21fc4d7d by Chris Lamb at 2022-01-29T08:23:05-08:00
Improve documentation for --timeout due to a few misconceptions.

- - - - -


1 changed file:

- diffoscope/main.py


Changes:

=====================================
diffoscope/main.py
=====================================
@@ -370,7 +370,9 @@ def create_parser():
         "--timeout",
         metavar="SECONDS",
         type=int,
-        help="Best-effort attempt at a timeout in seconds. (default: no timeout) [experimental]",
+        help="Best-effort attempt at a global timeout in seconds. If enabled, "
+        "diffoscope will not recurse into any further sub-archives after X "
+        "seconds of total execution time. (default: no timeout) [experimental]",
         default=float("inf"),
     )
     group3.add_argument(



View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/-/commit/21fc4d7d46ad8eb27327bba2a47fe98e672d600b

-- 
View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/-/commit/21fc4d7d46ad8eb27327bba2a47fe98e672d600b
You're receiving this email because of your account on salsa.debian.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.reproducible-builds.org/pipermail/rb-commits/attachments/20220129/bfa49c66/attachment.htm>