From d8a432a99235d4890ff994ea3c2a68dd1e3ce0ef Mon Sep 17 00:00:00 2001 From: Wolfgang Frisch Date: Wed, 24 Jan 2024 13:43:27 +0100 Subject: [PATCH] Document new option `ignore_incomplete_reads`. https://github.com/thp/urlwatch/issues/725 --- docs/source/advanced.rst | 6 ++++++ docs/source/jobs.rst | 1 + share/man/man5/urlwatch-jobs.5 | 2 ++ 3 files changed, 9 insertions(+) diff --git a/docs/source/advanced.rst b/docs/source/advanced.rst index 856a06a5..9aaf55b4 100644 --- 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 index 8c55d585..2ab4b692 100644 --- 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 index 8575529e..222df5e6 100644 --- 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)