X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;ds=sidebyside;f=guestfs-actions.pod;h=eec66977bd35c9d7ce3c20c6f2663371806c0f0e;hb=1cf85b1e60e85c4940869c6291d75ac44a5bd190;hp=352760dd1150a610cb445fa82dffb1f1158d9b80;hpb=bf17bf81fef275892d24458ce5f1e5290b426742;p=libguestfs.git

diff --git a/guestfs-actions.pod b/guestfs-actions.pod
index 352760d..eec6697 100644
--- a/guestfs-actions.pod
+++ b/guestfs-actions.pod
@@ -5,6 +5,11 @@
 
 Return the contents of the file named C<path>.
 
+Note that this function cannot correctly handle binary files
+(specifically, files containing C<\0> character which is treated
+as end of string).  For those you need to use the C<guestfs_read>
+function which has a more complex interface.
+
 This function returns a string or NULL on error.  The caller
 must free the returned string after use.
 
@@ -35,7 +40,8 @@ List the files in C<directory> (relative to the root directory,
 there is no cwd).  The '.' and '..' entries are not returned, but
 hidden files are shown.
 
-This command is mostly useful for interactive sessions.
+This command is mostly useful for interactive sessions.  Programs
+should probably use C<guestfs_readdir> instead.
 
 This function returns a NULL-terminated array of strings
 (like L<environ(3)>), or NULL if there was an error.