]> xenbits.xensource.com Git - xen.git/commitdiff
docs: add DIRECTORY_PART specification do xenstore protocol doc
authorJuergen Gross <jgross@suse.com>
Mon, 27 Jan 2020 16:50:50 +0000 (17:50 +0100)
committerIan Jackson <ian.jackson@eu.citrix.com>
Tue, 5 May 2020 14:15:40 +0000 (15:15 +0100)
DIRECTORY_PART was missing in docs/misc/xenstore.txt. Add it.

Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Paul Durrant <pdurrant@amazon.com>
Acked-by: Wei Liu <wl@xen.org>
Backport: 4.9+
(cherry picked from commit 94a0252c10cb9938bdee98cc456c23e17b28eafb)
(cherry picked from commit 5c1b607e8a4de32fc2238f4d29d477007eb5822c)
(cherry picked from commit e84b63444e190a8c4380c130c120e1d3e6f4cf31)

docs/misc/xenstore.txt

index ae1b6a8c6e43f47aae7ece8e9537f3f1fd03a4bb..65570183b67e811e4d42a472366262fe03a14e74 100644 (file)
@@ -152,6 +152,15 @@ DIRECTORY          <path>|                 <child-leaf-name>|*
        leafnames.  The resulting children are each named
        <path>/<child-leaf-name>.
 
+DIRECTORY_PART         <path>|<offset>         <gencnt>|<child-leaf-name>|*
+       Same as DIRECTORY, but to be used for children lists longer than
+       XENSTORE_PAYLOAD_MAX. Input are <path> and the byte offset into
+       the list of children to return. Return values are the generation
+       count <gencnt> of the node (to be used to ensure the node hasn't
+       changed between two reads: <gencnt> being the same for multiple
+       reads guarantees the node hasn't changed) and the list of children
+       starting at the specified <offset> of the complete list.
+
 GET_PERMS              <path>|                 <perm-as-string>|+
 SET_PERMS              <path>|<perm-as-string>|+?
        <perm-as-string> is one of the following