From 699f38f05f2545a2c188370500df17cc52cbdf98 Mon Sep 17 00:00:00 2001 From: Richard Jones Date: Mon, 15 Feb 2010 23:15:17 +0000 Subject: [PATCH] Turn ProtocolLimitWarning into link to documentation section. --- src/generator.ml | 3 +-- src/guestfs.pod | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+), 2 deletions(-) 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." +of somewhere between 2MB and 4MB. See L." let danger_will_robinson = "B 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 +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 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 and L document how to do this. + +You might also consider mounting the disk image using our FUSE +filesystem support (L). + =head1 CONNECTION MANAGEMENT =head2 guestfs_h * -- 1.8.3.1