[PATCH] xenstore: Clarify xs_open() semantics

[PATCH] xenstore: Clarify xs_open() semantics

[Razvan Cojocaru]

Added to the xs_open() comments in xenstore.h. The text has been
taken almost verbatim from a xen-devel email by Ian Campbell,
and confirmed as accurate by Ian Jackson.

Signed-off-by: Razvan Cojocaru <rcojocaru@bitdefender.com>
Suggested-off-by: Ian Campbell <Ian.Campbell@citrix.com>
---
 tools/xenstore/include/xenstore.h |   12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/tools/xenstore/include/xenstore.h b/tools/xenstore/include/xenstore.h
index fdf5e76..b4b113e 100644
--- a/tools/xenstore/include/xenstore.h
+++ b/tools/xenstore/include/xenstore.h
@@ -59,10 +59,20 @@ typedef uint32_t xs_transaction_t;
 /* On failure, these routines set errno. */
 
 /* Open a connection to the xs daemon.
- * Attempts to make a connection over the socket interface, 
+ * Attempts to make a connection over the socket interface,
  * and if it fails, then over the  xenbus interface.
  * Mode 0 specifies read-write access, XS_OPEN_READONLY for
  * read-only access.
+ *
+ * * Connections made with xs_open(0) (which might be shared page or
+ *   socket based) are only guaranteed to work in the parent after
+ *   fork.
+ * * Connections made with xs_open(XS_OPEN_SOCKETONLY) will be usable
+ *   in either the parent or the child after fork, but not both.
+ * * xs_daemon_open*() and xs_domain_open() are deprecated synonyms
+ *   for xs_open(0).
+ * * XS_OPEN_READONLY has no bearing on any of this.
+ *
  * Returns a handle or NULL.
  */
 struct xs_handle *xs_open(unsigned long flags);
-- 
1.7.9.5

[PATCH] xenstore: Clarify xs_open() semantics

[Ian Jackson]

Razvan Cojocaru writes ("[PATCH] xenstore: Clarify xs_open() semantics"):
> Added to the xs_open() comments in xenstore.h. The text has been
> taken almost verbatim from a xen-devel email by Ian Campbell,
> and confirmed as accurate by Ian Jackson.
> 
> Signed-off-by: Razvan Cojocaru <rcojocaru@bitdefender.com>
> Suggested-off-by: Ian Campbell <Ian.Campbell@citrix.com>

Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>

Re: [PATCH] xenstore: Clarify xs_open() semantics

[Konrad Rzeszutek Wilk]

On Fri, Nov 28, 2014 at 12:31:34PM +0000, Ian Jackson wrote:
> Razvan Cojocaru writes ("[PATCH] xenstore: Clarify xs_open() semantics"):
> > Added to the xs_open() comments in xenstore.h. The text has been
> > taken almost verbatim from a xen-devel email by Ian Campbell,
> > and confirmed as accurate by Ian Jackson.
> > 
> > Signed-off-by: Razvan Cojocaru <rcojocaru@bitdefender.com>
> > Suggested-off-by: Ian Campbell <Ian.Campbell@citrix.com>
> 
> Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>

It is documentation per say so it can go in ..
> 
> _______________________________________________
> Xen-devel mailing list
> Xen-devel@lists.xen.org
> http://lists.xen.org/xen-devel

Re: [PATCH] xenstore: Clarify xs_open() semantics

[Ian Campbell]

On Mon, 2014-12-01 at 16:16 -0500, Konrad Rzeszutek Wilk wrote:
> On Fri, Nov 28, 2014 at 12:31:34PM +0000, Ian Jackson wrote:
> > Razvan Cojocaru writes ("[PATCH] xenstore: Clarify xs_open() semantics"):
> > > Added to the xs_open() comments in xenstore.h. The text has been
> > > taken almost verbatim from a xen-devel email by Ian Campbell,
> > > and confirmed as accurate by Ian Jackson.
> > > 
> > > Signed-off-by: Razvan Cojocaru <rcojocaru@bitdefender.com>
> > > Suggested-off-by: Ian Campbell <Ian.Campbell@citrix.com>
> > 
> > Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
> 
> It is documentation per say so it can go in ..

Applied.