]> xenbits.xensource.com Git - xen.git/commitdiff
docs: document CONTROL command of xenstore protocol
authorJuergen Gross <jgross@suse.com>
Tue, 28 Jan 2020 06:21:07 +0000 (06:21 +0000)
committerIan Jackson <ian.jackson@eu.citrix.com>
Tue, 5 May 2020 14:16:09 +0000 (15:16 +0100)
The CONTROL command (former DEBUG command) isn't specified in the
xenstore protocol doc. Add it.

Signed-off-by: Juergen Gross <jgross@suse.com>
Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
Backport: 4.9+
(cherry picked from commit f910c3ebc6a178c5cbbc0868134be536fae7f7cf)
(cherry picked from commit daf71f0053e21ebefb0e21431ef48d53af1c3b31)
(cherry picked from commit afe82f5781bf402e56b23a46e41bbb055255a068)

docs/misc/xenstore.txt

index 65570183b67e811e4d42a472366262fe03a14e74..6f8569d5760f366c94f439ed75c83fd889496231 100644 (file)
@@ -318,12 +318,32 @@ SET_TARGET                <domid>|<tdomid>|
 
 ---------- Miscellaneous ----------
 
-DEBUG                  print|<string>|??           sends <string> to debug log
-DEBUG                  print|<thing-with-no-nul>   EINVAL
-DEBUG                  check|??                    checks xenstored innards
-DEBUG                  <anything-else|>            no-op (future extension)
-
-       These requests should not generally be used and may be
-       withdrawn in the future.
-
+CONTROL                        <command>|[<parameters>|]
+       Send a control command <command> with optional parameters
+       (<parameters>) to Xenstore daemon.
+
+       The set of commands and their semantics is implementation
+       specific and is likely to change from one Xen version to the
+       next.  Out-of-tree users will encounter compatibility issues.
+
+       Current commands are:
+       check
+               checks xenstored innards
+       log|on
+               turn xenstore logging on
+       log|off
+               turn xenstore logging off
+       logfile|<file-name>
+               log to specified file
+       memreport|[<file-name>]
+               print memory statistics to logfile (no <file-name>
+               specified) or to specific file
+       print|<string>
+               print <string> to syslog (xenstore runs as daemon) or
+               to console (xenstore runs as stubdom)
+       help                    <supported-commands>
+               return list of supported commands for CONTROL
+
+DEBUG
+       Deprecated, now named CONTROL