From: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
Date: Mon, 28 Jan 2013 18:21:59 +0000 (-0500)
Subject: docs: Document the XenBus structure.
X-Git-Tag: archive/raspbian/4.8.0-1+rpi1~1^2~7071^2
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=b3138fd1120da98e5dc4a942fc25da50eca787a7;p=xen.git

docs: Document the XenBus structure.

Mark-up for inclusion of generated docs.

Acked-by: Ian Campbell <ian.campbel@citrix.com>
Signed-off-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
---

diff --git a/xen/include/public/io/xs_wire.h b/xen/include/public/io/xs_wire.h
index 36ff33c2ca..99d24e3ddd 100644
--- a/xen/include/public/io/xs_wire.h
+++ b/xen/include/public/io/xs_wire.h
@@ -103,7 +103,10 @@ enum xs_watch_type
     XS_WATCH_TOKEN
 };
 
-/* Inter-domain shared memory communications. */
+/*
+ * `incontents 150 xenstore_struct XenStore wire protocol.
+ *
+ * Inter-domain shared memory communications. */
 #define XENSTORE_RING_SIZE 1024
 typedef uint32_t XENSTORE_RING_IDX;
 #define MASK_XENSTORE_IDX(idx) ((idx) & (XENSTORE_RING_SIZE-1))