From 7ab964a3e3d5509f6dcb96e300b8e65b3aa71ff9 Mon Sep 17 00:00:00 2001
From: JanHoefelmeyer <107021473+JanHoefelmeyer@users.noreply.github.com>
Date: Mon, 1 Sep 2025 11:48:56 +0200
Subject: [PATCH] Doc: Highlight the reason for the rate options existence
 (#662)

* Doc: Highlight the reason for the rate options existence

* Fix typos
---
 docs/csaf_aggregator.md | 6 ++++++
 docs/csaf_checker.md    | 7 +++++++
 docs/csaf_downloader.md | 6 ++++++
 3 files changed, 19 insertions(+)

diff --git a/docs/csaf_aggregator.md b/docs/csaf_aggregator.md
index 661871c..04efa3a 100644
--- a/docs/csaf_aggregator.md
+++ b/docs/csaf_aggregator.md
@@ -247,3 +247,9 @@ insecure = true
 In case you want to provide CSAF advisories from others
 that only qualify as CSAF publishers, see
 [how to use the `csaf_aggregator` as "CSAF proxy provider"](proxy-provider-for-aggregator.md).
+
+Some providers may limit the rate of requests that may be sent to retrieve advisories.
+This may cause issues with the aggregator. 
+In this case, the --rate option can be used to adjust the requests per second
+sent by each worker of the aggregator to an acceptable rate.
+(The rate that is considered acceptable depends on the provider.)
diff --git a/docs/csaf_checker.md b/docs/csaf_checker.md
index 5152501..5c812bd 100644
--- a/docs/csaf_checker.md
+++ b/docs/csaf_checker.md
@@ -78,6 +78,13 @@ The option `timerange` allows to only check advisories from a given time
 interval. It can only be given once. See the
 [downloader documentation](csaf_downloader.md#timerange-option) for details.
 
+Some providers may limit the rate of requests that may be sent to retrieve advisories.
+This may cause the checker to be unable to retrieve all advisories. In this case,
+the --rate option can be used to adjust the requests per second
+sent by the checker to an acceptable rate.
+(The rate that is considered acceptable depends on the provider.)
+
+
 You can ignore certain advisories while checking by specifying a list
 of regular expressions[^1] to match their URLs by using the `ignorepattern`
 option.
diff --git a/docs/csaf_downloader.md b/docs/csaf_downloader.md
index d71b546..9168f3c 100644
--- a/docs/csaf_downloader.md
+++ b/docs/csaf_downloader.md
@@ -51,6 +51,12 @@ to download more advisories at once. This may improve the overall speed of the d
 However, since this also increases the load on the servers, their administrators could
 have taken countermeasures to limit this.
 
+For example, some providers may limit the rate of requests that may be sent to retrieve advisories.
+This may cause the downloader to be unable to retrieve all advisories. 
+In this case, the --rate option can be used to adjust the requests per second
+sent by the downloader to an acceptable rate.
+(The rate that is considered acceptable depends on the provider.)
+
 If no config file is explictly given the follwing places are searched for a config file:
 
 ```