From 4a230979bb4f6d0a13b42b992b99aa8b94435e46 Mon Sep 17 00:00:00 2001 From: Richard Jones Date: Thu, 2 Sep 2010 11:11:55 +0100 Subject: [PATCH] perl: Document handle is a hashref. For details see commit eb566f7dc7974b42ac65729a2e5e5bcee329a0a9. (cherry picked from commit b8b0c99b46172712aa190f70182734934587af7b) --- src/generator.ml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/generator.ml b/src/generator.ml index b61e43c..d743c89 100755 --- a/src/generator.ml +++ b/src/generator.ml @@ -9282,6 +9282,24 @@ L. For further discussion on this topic, refer to L. +=head1 STORING DATA IN THE HANDLE + +The handle returned from L is a hash reference. The hash +normally contains a single element: + + { + _g => [private data used by libguestfs] + } + +Callers can add other elements to this hash to store data for their own +purposes. The data lasts for the lifetime of the handle. + +Any fields whose names begin with an underscore are reserved +for private use by libguestfs. We may add more in future. + +It is recommended that callers prefix the name of their field(s) +with some unique string, to avoid conflicts with other users. + =head1 COPYRIGHT Copyright (C) %s Red Hat Inc. -- 1.8.3.1