From 9bd3d5bc6d6a3be517da5faf9e7c8a84394ca0f9 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Sat, 6 Oct 2012 17:41:36 +0100 Subject: FAQ: Document debug* and internal* functions in the FAQ. --- examples/guestfs-faq.pod | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) 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 and C functions do? + +There are some functions which are used for debugging and +internal purposes which are I part of the stable API. + +The C (or C) functions, primarily +L 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 (or C) 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, -- cgit