From 7fd4f710a12c213b19b02cbbde4c7cb9247bf09d Mon Sep 17 00:00:00 2001 From: tobi-wan-kenobi Date: Sat, 19 Dec 2020 13:17:05 +0100 Subject: [PATCH] [doc] improve interval documentation Add information about global vs. per-module intervals. see #751 --- docs/introduction.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/introduction.rst b/docs/introduction.rst index 927a384..a27b8c7 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -56,8 +56,16 @@ To change the update interval, use: $ ./bumblebee-status -m -p interval= +Note that some modules define their own intervals (e.g. most modules that query +an online service), such as to not cause a storm of "once every second" queries. + +For such modules, the "global" interval defined here effectively defines the +highest possible "resolution". If you have a global interval of 10s, for example, +any other module can update at 10s, 20s, 30s, etc., but not every 25s. The status +bar will internally always align to the next future time slot. + The update interval can also be changed on a per-module basis, like -this: +this (overriding the default module interval indicated above): .. code-block:: bash