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.
2020-09-23 23:55:50 +02:00
parent 579d46f78a
commit 0bb4f144fc
2 changed files with 33 additions and 6 deletions
@@ -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.