summaryrefslogtreecommitdiffstats
path: root/docs/aoa
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2023-01-22 11:14:59 +0100
committernicolargo <nicolas@nicolargo.com>2023-01-22 11:14:59 +0100
commitb67c717b3af357f72bef8f4847dca4af84576389 (patch)
tree4f2b974acf04181726193b0421d8b1ea155cf34f /docs/aoa
parent67bf0c1964cc5900aed61f8af618d4b907c264fb (diff)
Improve documentation regarding regexp in configuration file
Diffstat (limited to 'docs/aoa')
-rw-r--r--docs/aoa/diskio.rst6
-rw-r--r--docs/aoa/docker.rst5
-rw-r--r--docs/aoa/fs.rst6
-rw-r--r--docs/aoa/network.rst6
4 files changed, 23 insertions, 0 deletions
diff --git a/docs/aoa/diskio.rst b/docs/aoa/diskio.rst
index 9a1e87d7..85125481 100644
--- a/docs/aoa/diskio.rst
+++ b/docs/aoa/diskio.rst
@@ -37,3 +37,9 @@ or another example:
[diskio]
show=sda.*
+
+Filtering is based on regular expression. Please be sure that your regular
+expression works as expected. You can use an online tool like `regex101`_ in
+order to test your regular expression.
+
+.. _regex101: https://regex101.com/ \ No newline at end of file
diff --git a/docs/aoa/docker.rst b/docs/aoa/docker.rst
index cc8c485b..568978d1 100644
--- a/docs/aoa/docker.rst
+++ b/docs/aoa/docker.rst
@@ -47,4 +47,9 @@ under the ``[docker]`` section:
You can use all the variables ({{foo}}) available in the Docker plugin.
+Filtering (for hide or show) is based on regular expression. Please be sure that your regular
+expression works as expected. You can use an online tool like `regex101`_ in
+order to test your regular expression.
+
+.. _regex101: https://regex101.com/
.. _docker-py: https://github.com/docker/docker-py
diff --git a/docs/aoa/fs.rst b/docs/aoa/fs.rst
index 8123bf1d..4d5dc100 100644
--- a/docs/aoa/fs.rst
+++ b/docs/aoa/fs.rst
@@ -53,3 +53,9 @@ Example to only show /dev/sdb mount points:
[fs]
show=/dev/sdb.*
+
+Filtering is based on regular expression. Please be sure that your regular
+expression works as expected. You can use an online tool like `regex101`_ in
+order to test your regular expression.
+
+.. _regex101: https://regex101.com/ \ No newline at end of file
diff --git a/docs/aoa/network.rst b/docs/aoa/network.rst
index 27ad1581..a1f116ac 100644
--- a/docs/aoa/network.rst
+++ b/docs/aoa/network.rst
@@ -53,3 +53,9 @@ virtual docker interface (docker0, docker1, ...):
wlan0_tx_warning=900000
wlan0_tx_critical=1000000
wlan0_tx_log=True
+
+Filtering is based on regular expression. Please be sure that your regular
+expression works as expected. You can use an online tool like `regex101`_ in
+order to test your regular expression.
+
+.. _regex101: https://regex101.com/ \ No newline at end of file