Document new option ignore_incomplete_reads.

thp#725
wfrisch · Feb 14, 2024 · b6f7cff · b6f7cff
1 parent 0ea72dc
commit b6f7cff
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ The format mostly follows [Keep a Changelog](http://keepachangelog.com/en/1.0.0/
 ### Added
 
 - New `enabled` option for all jobs. Set to false to disable a job without needing to remove it or comment it out (Requested in #625 by snowman, contributed in #785 by jamstah)
+- New option `ignore_incomplete_reads` (PR#787, by wfrisch)
 
 ### Changed
 

diff --git a/docs/source/advanced.rst b/docs/source/advanced.rst
@@ -181,6 +181,12 @@ or ignore all HTTP errors if you like:
    url: https://example.com/
    ignore_http_error_codes: 4xx, 5xx
 
+You can also ignore incomplete reads:
+
+.. code-block:: yaml
+
+   url: "https://example.com/"
+   ignore_incomplete_reads: true
 
 Overriding the content encoding
 -------------------------------

diff --git a/docs/source/jobs.rst b/docs/source/jobs.rst
@@ -60,6 +60,7 @@ Job-specific optional keys:
 - ``ignore_http_error_codes``: List of HTTP errors to ignore (see :ref:`advanced_topics`)
 - ``ignore_timeout_errors``: Do not report errors when the timeout is hit
 - ``ignore_too_many_redirects``: Ignore redirect loops (see :ref:`advanced_topics`)
+- ``ignore_incomplete_reads``: Ignore incomplete HTTP responses (see :ref:`advanced_topics`)
 
 (Note: ``url`` implies ``kind: url``)