Skip to contentSkip to conversation

docs: document CONTROL command of xenstore protocol

PATCH In review Juergen Gross 3 participants 3 messages Jan 28, 2020

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 docs: document CONTROL command of xenstore protocol

The CONTROL command (former DEBUG command) isn't specified in the xenstore protocol doc. Add it.

---
 docs/misc/xenstore.txt | 36 ++++++++++++++++++++++++++++--------
 1 file changed, 28 insertions(+), 8 deletions(-)
docs/misc/xenstore.txt +28 -8
index 65570183b6..6f8569d576 100644
@@ -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
 
Signature · 7 lines
2.16.4


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Acked-by
#2 lore raw

Wei Liu writes ("Re: [PATCH v2] docs: document CONTROL command of xenstore protocol"):

Quoted 8 lines · Juergen Gross
Quoted 4 lines

The CONTROL command (former DEBUG command) isn't specified in the xenstore protocol doc. Add it.

Backport: 4.9+

And applied, thanks.

Ian.

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel