diff --git a/doc/man/salt-call.1 b/doc/man/salt-call.1 index 2083f53e0a..547468a8f7 100644 --- a/doc/man/salt-call.1 +++ b/doc/man/salt-call.1 @@ -206,7 +206,8 @@ using the Python \fBpprint\fP standard library module. .INDENT 7.0 .INDENT 3.5 If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well. -Without the static option, you will get a JSON string for each minion. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use \fB\-\-static\fP as well. .UNINDENT diff --git a/doc/man/salt-cloud.1 b/doc/man/salt-cloud.1 index 28a287d725..35a460fdc0 100644 --- a/doc/man/salt-cloud.1 +++ b/doc/man/salt-cloud.1 @@ -255,7 +255,8 @@ using the Python \fBpprint\fP standard library module. .INDENT 7.0 .INDENT 3.5 If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well. -Without the static option, you will get a JSON string for each minion. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use \fB\-\-static\fP as well. .UNINDENT diff --git a/doc/man/salt-key.1 b/doc/man/salt-key.1 index 919b7280ce..e42267aa6a 100644 --- a/doc/man/salt-key.1 +++ b/doc/man/salt-key.1 @@ -135,7 +135,8 @@ using the Python \fBpprint\fP standard library module. .INDENT 7.0 .INDENT 3.5 If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well. -Without the static option, you will get a JSON string for each minion. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use \fB\-\-static\fP as well. .UNINDENT diff --git a/doc/man/salt-ssh.1 b/doc/man/salt-ssh.1 index 59a88a43d8..d9a1aa884c 100644 --- a/doc/man/salt-ssh.1 +++ b/doc/man/salt-ssh.1 @@ -221,7 +221,8 @@ using the Python \fBpprint\fP standard library module. .INDENT 7.0 .INDENT 3.5 If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well. -Without the static option, you will get a JSON string for each minion. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use \fB\-\-static\fP as well. .UNINDENT diff --git a/doc/man/salt.1 b/doc/man/salt.1 index d40efec417..40a57282df 100644 --- a/doc/man/salt.1 +++ b/doc/man/salt.1 @@ -82,8 +82,10 @@ query the minions and check on running jobs. Default: 5 .B \-s, \-\-static By default as of version 0.9.8 the salt command returns data to the console as it is received from minions, but previous releases would return -data only after all data was received. To only return the data with a hard -timeout and after all minions have returned then use the static option. +data only after all data was received. Use the static option to only return +the data with a hard timeout and after all minions have returned. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. .UNINDENT .INDENT 0.0 .TP @@ -280,7 +282,8 @@ using the Python \fBpprint\fP standard library module. .INDENT 7.0 .INDENT 3.5 If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well. -Without the static option, you will get a JSON string for each minion. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use \fB\-\-static\fP as well. .UNINDENT diff --git a/doc/man/salt.7 b/doc/man/salt.7 index 95e324f01b..139207ab58 100644 --- a/doc/man/salt.7 +++ b/doc/man/salt.7 @@ -19174,7 +19174,8 @@ using the Python \fBpprint\fP standard library module. .INDENT 7.0 .INDENT 3.5 If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well. -Without the static option, you will get a JSON string for each minion. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use \fB\-\-static\fP as well. .UNINDENT @@ -31663,7 +31664,8 @@ using the Python \fBpprint\fP standard library module. .INDENT 7.0 .INDENT 3.5 If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well. -Without the static option, you will get a JSON string for each minion. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use \fB\-\-static\fP as well. .UNINDENT @@ -31760,8 +31762,10 @@ query the minions and check on running jobs. Default: 5 .B \-s, \-\-static By default as of version 0.9.8 the salt command returns data to the console as it is received from minions, but previous releases would return -data only after all data was received. To only return the data with a hard -timeout and after all minions have returned then use the static option. +data only after all data was received. Use the static option to only return +the data with a hard timeout and after all minions have returned. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. .UNINDENT .INDENT 0.0 .TP @@ -31958,7 +31962,8 @@ using the Python \fBpprint\fP standard library module. .INDENT 7.0 .INDENT 3.5 If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well. -Without the static option, you will get a JSON string for each minion. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use \fB\-\-static\fP as well. .UNINDENT @@ -32228,7 +32233,8 @@ using the Python \fBpprint\fP standard library module. .INDENT 7.0 .INDENT 3.5 If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well. -Without the static option, you will get a JSON string for each minion. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use \fB\-\-static\fP as well. .UNINDENT @@ -32579,7 +32585,8 @@ using the Python \fBpprint\fP standard library module. .INDENT 7.0 .INDENT 3.5 If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well. -Without the static option, you will get a JSON string for each minion. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use \fB\-\-static\fP as well. .UNINDENT @@ -33191,7 +33198,8 @@ using the Python \fBpprint\fP standard library module. .INDENT 7.0 .INDENT 3.5 If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well. -Without the static option, you will get a JSON string for each minion. +Without the static option, you will get a separate JSON string per minion +which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use \fB\-\-static\fP as well. .UNINDENT diff --git a/doc/ref/cli/_includes/output-options.rst b/doc/ref/cli/_includes/output-options.rst index 433d8a1f61..0128a1cfb0 100644 --- a/doc/ref/cli/_includes/output-options.rst +++ b/doc/ref/cli/_includes/output-options.rst @@ -18,7 +18,8 @@ Output Options .. note:: If using ``--out=json``, you will probably want ``--static`` as well. - Without the static option, you will get a JSON string for each minion. + Without the static option, you will get a separate JSON string per minion + which makes JSON output invalid as a whole. This is due to using an iterative outputter. So if you want to feed it to a JSON parser, use ``--static`` as well. diff --git a/doc/ref/cli/salt.rst b/doc/ref/cli/salt.rst index f6e47ecb7e..dd98950196 100644 --- a/doc/ref/cli/salt.rst +++ b/doc/ref/cli/salt.rst @@ -34,8 +34,10 @@ Options By default as of version 0.9.8 the salt command returns data to the console as it is received from minions, but previous releases would return - data only after all data was received. To only return the data with a hard - timeout and after all minions have returned then use the static option. + data only after all data was received. Use the static option to only return + the data with a hard timeout and after all minions have returned. + Without the static option, you will get a separate JSON string per minion + which makes JSON output invalid as a whole. .. option:: --async