diff options
| author | Richard W.M. Jones <rjones@redhat.com> | 2012-10-06 17:41:36 +0100 |
|---|---|---|
| committer | Richard W.M. Jones <rjones@redhat.com> | 2012-10-06 17:42:05 +0100 |
| commit | 9bd3d5bc6d6a3be517da5faf9e7c8a84394ca0f9 (patch) | |
| tree | d0dcc011ca60b67887036f0a0fd13170f489307b | |
| parent | 8e198dc1c50fcdba6720b23da478ef75cc979733 (diff) | |
| download | libguestfs-9bd3d5bc6d6a3be517da5faf9e7c8a84394ca0f9.tar.gz libguestfs-9bd3d5bc6d6a3be517da5faf9e7c8a84394ca0f9.tar.xz libguestfs-9bd3d5bc6d6a3be517da5faf9e7c8a84394ca0f9.zip | |
FAQ: Document debug* and internal* functions in the FAQ.
| -rw-r--r-- | examples/guestfs-faq.pod | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/examples/guestfs-faq.pod b/examples/guestfs-faq.pod index 561cf06d..7d4a316c 100644 --- a/examples/guestfs-faq.pod +++ b/examples/guestfs-faq.pod @@ -776,6 +776,23 @@ operating system within the disk image you gave it. You might see this from programs like virt-cat if you try to run them on something which is just a disk image, not a virtual machine disk image. +=head2 What do these C<debug*> and C<internal-*> functions do? + +There are some functions which are used for debugging and +internal purposes which are I<not> part of the stable API. + +The C<debug*> (or C<guestfs_debug*>) functions, primarily +L<guestfs(3)/guestfs_debug> and a handful of others, are used for +debugging libguestfs. Although they are not part of the stable API +and thus may change or be removed at any time, some programs may want +to call these while waiting for features to be added to libguestfs. + +The C<internal-*> (or C<guestfs_internal_*>) functions are purely to +be used by libguestfs itself. There is no reason for programs to call +them, and programs should not try to use them. Using them will often +cause bad things to happen, as well as not being part of the +documented stable API. + =head1 SEE ALSO L<guestfish(1)>, |