From: Juergen Gross <jgross@suse.com>
Date: Tue, 28 Jan 2020 06:21:07 +0000 (+0000)
Subject: docs: document CONTROL command of xenstore protocol
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=a4dd2feb8c52709d81d0b253e712a3531ac7294f;p=xen.git

docs: document CONTROL command of xenstore protocol

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)
---

diff --git a/docs/misc/xenstore.txt b/docs/misc/xenstore.txt
index 65570183b6..6f8569d576 100644
--- a/docs/misc/xenstore.txt
+++ b/docs/misc/xenstore.txt
@@ -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