Document new option ignore_incomplete_reads.

thp#725
wfrisch · Jan 24, 2024 · d8a432a · d8a432a
1 parent 696d9f2
commit d8a432a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
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``)
 

diff --git a/share/man/man5/urlwatch-jobs.5 b/share/man/man5/urlwatch-jobs.5
@@ -107,6 +107,8 @@ Job\-specific optional keys:
 \fBignore_timeout_errors\fP: Do not report errors when the timeout is hit
 .IP \(bu 2
 \fBignore_too_many_redirects\fP: Ignore redirect loops (see \fI\%Advanced Topics\fP)
+.IP \(bu 2
+\fBignore_incomplete_reads\fP: Ignore incomplete HTTP responses (see \fI\%Advanced Topics\fP)
 .UNINDENT
 .sp
 (Note: \fBurl\fP implies \fBkind: url\fP)