summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFélix Baylac-Jacqué <felix@alternativebit.fr>2020-08-31 22:26:21 +0200
committerlouiz’ <louiz@louiz.org>2020-09-23 23:55:50 +0200
commit0bb4f144fcded6b5753b5de7493b7b10474c9a1f (patch)
tree11b3d1fbdd86c9ff68147f3cca5934b9e834b285 /doc
parent579d46f78ae5cf6a5e3e56772f7767d796765740 (diff)
downloadbiboumi-0bb4f144fcded6b5753b5de7493b7b10474c9a1f.tar.gz
biboumi-0bb4f144fcded6b5753b5de7493b7b10474c9a1f.tar.bz2
biboumi-0bb4f144fcded6b5753b5de7493b7b10474c9a1f.tar.xz
biboumi-0bb4f144fcded6b5753b5de7493b7b10474c9a1f.zip
CLI: Add a test config flag
Adding a -t configuration flag that will make biboumi check the configuration file syntax. Such a syntax check is handy for some deployment tools. It helps the tooling to statically analyse the configuration file and prevent unecessesary deployments when the configuration file is clearly incorrect. Updating the synopsis with this new flag.
Diffstat (limited to 'doc')
-rw-r--r--doc/synopsis.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/synopsis.rst b/doc/synopsis.rst
index 5b93a92..2b28c74 100644
--- a/doc/synopsis.rst
+++ b/doc/synopsis.rst
@@ -1,4 +1,19 @@
Synopsis
========
-biboumi [*config_filename*]
+biboumi [-ht] [*config_filename*]
+
+Command-Line Options
+========
+
+-h, \\-\\-help
+~~~~~~~~
+
+Display a help message and exit.
+
+-t, \\-\\-test-config
+~~~~~~~~
+
+Do not run, just test the configuration file syntax. Exit with a 0
+status if the configuration is valid, exits with a non-zero status
+otherwise.