mirrors/libguestfs
1
0
Fork 0
mirror of https://github.com/libguestfs/libguestfs.git synced 2026-03-22 07:03:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

guestfs(3): Refresh documentation for private data area keys.

Browse Source
This commit is contained in:
Richard W.M. Jones
2011-04-30 19:38:20 -04:00
parent e1836891d4
commit 40f2b698ac
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/guestfs.pod
View File

@@ -1962,12 +1962,13 @@ To attach a named piece of data, use the following call:
C<key> is the name to associate with this data, and C<data> is an
arbitrary pointer (which can be C<NULL>). Any previous item with the
same name is overwritten.
same key is overwritten.
You can use any C<key> 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<key> you want, but your key should I<not> 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: