From 0bb4f144fcded6b5753b5de7493b7b10474c9a1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Baylac-Jacqu=C3=A9?= Date: Mon, 31 Aug 2020 22:26:21 +0200 Subject: 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. --- doc/synopsis.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'doc') 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. -- cgit v1.2.3