Add clarification on default output format

InfraBuilder · Dec 18, 2020 · 6c62104 · 6c62104
1 parent 4ea2a75
commit 6c62104
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -159,6 +159,7 @@ There are two modes :
 Mandatory flags :
     -fd <path>
     --from-data <path>          : Define the path to the data to read from
+                                  Data file must be rendered with '--output data'
 
 =====[ Common optionnal flags ]============================================
 
@@ -186,7 +187,7 @@ Mandatory flags :
                                   Defaults to '--width 900 --height 500'
 
     -o <format>
-    --output <format>           : Set the output format
+    --output <format>           : Set the output format. Defaults to 'text'
                                   Possible values: text, yaml, json, data
     -v
     --verbose                   : Activate the verbose mode by setting debug-level to 'info'

diff --git a/knb b/knb
@@ -189,6 +189,7 @@ function usage {
 	Mandatory flags :
 	    -fd <path>
 	    --from-data <path>          : Define the path to the data to read from
+					  Data file must be rendered with '--output data'
 
 	=====[ Common optionnal flags ]============================================
 
@@ -216,7 +217,7 @@ function usage {
 	                                  Defaults to '--width 900 --height 500'
 
 	    -o <format>
-	    --output <format>           : Set the output format
+	    --output <format>           : Set the output format. Defaults to 'text'
 	                                  Possible values: text, yaml, json, data, ibdbench
 	    -v
 	    --verbose                   : Activate the verbose mode by setting debug-level to 'info'