docs: retrospectively add XS_DIRECTORY_PART to the xenstore protocol...

... specification.

This was added by commit 0ca64ed8 "xenstore: add support for reading
directory with many children" but not added to the specification at that
point. A version of xenstored supporting the command was first released
in Xen 4.9.

Signed-off-by: Paul Durrant <pdurrant@amazon.com>
Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
Backport: 4.9+

diff --git a/docs/misc/xenstore.txt b/docs/misc/xenstore.txt
index ae1b6a8c6e43f47aae7ece8e9537f3f1fd03a4bb..bf42e9ec3780cd7f89a69f411372be0a6ac03aed 100644 (file)
--- a/docs/misc/xenstore.txt
+++ b/docs/misc/xenstore.txt
@@ -125,8 +125,9 @@ Values commonly included in payloads include:
 
 
 
-The following are the actual type values, including the request and
-reply payloads as applicable:
+The following are the actual type values defined in io/xs_wire.h
+(omitting the XS_ prefix), including the request and reply payloads
+as applicable:
 
 
 ---------- Database read, write and permissions operations ----------
@@ -152,6 +153,14 @@ DIRECTORY          <path>|                 <child-leaf-name>|*
        leafnames.  The resulting children are each named
        <path>/<child-leaf-name>.
 
+DIRECTORY_PART         <path>|<index|>         <child-leaf-name>|*
+       Performs the same function as DIRECTORY, but returns a
+       sub-list of children starting at <index> in the overall
+       child list and less than or equal to XENSTORE_PAYLOAD_MAX
+       octets in length. If <index> is beyond the end of the
+       overall child list then the returned sub-list will be
+       empty.
+
 GET_PERMS              <path>|                 <perm-as-string>|+
 SET_PERMS              <path>|<perm-as-string>|+?
        <perm-as-string> is one of the following