diff options
| author | Richard W.M. Jones <rjones@redhat.com> | 2011-04-30 19:38:20 -0400 |
|---|---|---|
| committer | Richard W.M. Jones <rjones@redhat.com> | 2011-04-30 19:39:01 -0400 |
| commit | 40f2b698ac765128bfcda5f0db893c95d09ae89a (patch) | |
| tree | ffdaa825aceb55bd298f580027171daec142028f /src | |
| parent | e1836891d435b9ef47e68949a3d69b1258924d0c (diff) | |
| download | libguestfs-40f2b698ac765128bfcda5f0db893c95d09ae89a.tar.gz libguestfs-40f2b698ac765128bfcda5f0db893c95d09ae89a.tar.xz libguestfs-40f2b698ac765128bfcda5f0db893c95d09ae89a.zip | |
guestfs(3): Refresh documentation for private data area keys.
Diffstat (limited to 'src')
| -rw-r--r-- | src/guestfs.pod | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/src/guestfs.pod b/src/guestfs.pod index e546029a..7cfd2b29 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -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: |