From: Klaus Aehlig Date: Tue, 1 Sep 2015 13:23:41 +0000 (+0200) Subject: Document quoting of special values in key-value parameters X-Git-Tag: v2.9.7~7 X-Git-Url: http://git.ganeti.org/?p=ganeti-github.git;a=commitdiff_plain;h=68705edf8f6ab4a51174e60a45c634f36c000e77;ds=sidebyside Document quoting of special values in key-value parameters Since the early days of Ganeti, it is possible to pass in key-value parameters also some special non-string values (the two boolean values True and False and the special value None). However, the syntax for entering them was never properly documented confusing people who had to pass one of those values. So document it now. Signed-off-by: Klaus Aehlig Reviewed-by: Petr Pudlak --- diff --git a/man/ganeti.rst b/man/ganeti.rst index 153cd23..4024ed1 100644 --- a/man/ganeti.rst +++ b/man/ganeti.rst @@ -334,6 +334,13 @@ behaviour):: # gnt-instance modify -H kernel_path=an\\,example instance1 # gnt-instance modify -H kernel_path='an\,example' instance1 +Additionally, the following non-string parameters can be passed. To +pass the boolean value ``True``, only mention the key (leaving out the +equality sign and any value). To pass the boolean value ``False``, +again only mention the key, but prefix it with ``no_``. To pass the +special ``None`` value, again only mention the key, but prefix it with +a single ``-`` sign. + Query filters ~~~~~~~~~~~~~