From: Richard W.M. Jones Date: Sat, 30 Apr 2011 23:38:20 +0000 (-0400) Subject: guestfs(3): Refresh documentation for private data area keys. X-Git-Tag: 1.10.3~8 X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=20100e23bcdbf744b2e0e3c6c6f4a041e5daa73c;p=libguestfs.git guestfs(3): Refresh documentation for private data area keys. (cherry picked from commit 40f2b698ac765128bfcda5f0db893c95d09ae89a) --- diff --git a/src/guestfs.pod b/src/guestfs.pod index c537ae9..c19c9b6 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -1961,12 +1961,13 @@ To attach a named piece of data, use the following call: C is the name to associate with this data, and C is an arbitrary pointer (which can be C). Any previous item with the -same name is overwritten. +same key is overwritten. -You can use any C you want, but names beginning with an -underscore character are reserved for internal libguestfs purposes -(for implementing language bindings). It is recommended to prefix the -name with some unique string to avoid collisions with other users. +You can use any C you want, but your key should I start with +an underscore character. Keys beginning with an underscore character +are reserved for internal libguestfs purposes (eg. for implementing +language bindings). It is recommended that you prefix the key with +some unique string to avoid collisions with other users. To retrieve the pointer, use: