From: Richard Jones <rjones@redhat.com>
Date: Mon, 15 Feb 2010 23:15:17 +0000 (+0000)
Subject: Turn ProtocolLimitWarning into link to documentation section.
X-Git-Tag: 1.0.85~17
X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=699f38f05f2545a2c188370500df17cc52cbdf98;p=libguestfs.git

Turn ProtocolLimitWarning into link to documentation section.
---

diff --git a/src/generator.ml b/src/generator.ml
index fb8ed99..96b5b70 100755
--- a/src/generator.ml
+++ b/src/generator.ml
@@ -4704,8 +4704,7 @@ let seq_of_test = function
 (* Handling for function flags. *)
 let protocol_limit_warning =
   "Because of the message protocol, there is a transfer limit
-of somewhere between 2MB and 4MB.  To transfer large files, see
-L<guestfs(3)/UPLOADING>."
+of somewhere between 2MB and 4MB.  See L<guestfs(3)/PROTOCOL LIMITS>."
 
 let danger_will_robinson =
   "B<This command is dangerous.  Without careful use you
diff --git a/src/guestfs.pod b/src/guestfs.pod
index dd419ac..514db03 100644
--- a/src/guestfs.pod
+++ b/src/guestfs.pod
@@ -589,6 +589,29 @@ C<guestfish -c command> to run commands.
 
 =back
 
+=head2 PROTOCOL LIMITS
+
+Internally libguestfs uses a message-based protocol to pass API calls
+and their responses to and from a small "appliance" (see L</INTERNALS>
+for plenty more detail about this).  The maximum message size used by
+the protocol is slightly less than 4 MB.  For some API calls you may
+need to be aware of this limit.  The API calls which may be affected
+are individually documented, with a link back to this section of the
+documentation.
+
+A simple call such as C<guestfs_cat> returns its result (the file
+data) in a simple string.  Because this string is at some point
+internally encoded as a message, the maximum size that it can return
+is slightly under 4 MB.  If the requested file is larger than this
+then you will get an error.
+
+In order to transfer large files into and out of the guest filesystem,
+you need to use particular calls that support this.  The sections
+L</UPLOADING> and L</DOWNLOADING> document how to do this.
+
+You might also consider mounting the disk image using our FUSE
+filesystem support (L<guestmount(1)>).
+
 =head1 CONNECTION MANAGEMENT
 
 =head2 guestfs_h *