[Libguestfs] [PATCH 42/46] fish: Document that guestfish --remote --add won't work as expected (RHBZ#998513).

[Richard W.M. Jones]

From: "Richard W.M. Jones" <rjones at redhat.com>

(cherry picked from commit 7e396954611d827dc236a114ed22a781687c002d)
(cherry picked from commit 23e9cc95fa9cb8046a75613e0cc9ac92ad647c04)
---
 fish/guestfish.pod | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/fish/guestfish.pod b/fish/guestfish.pod
index d1d9827..8c34cbf 100644
--- a/fish/guestfish.pod
+++ b/fish/guestfish.pod
@@ -1027,6 +1027,24 @@ and cleans up guestfish when the script exits:
  
  # ...
 
+=head2 REMOTE CONTROL DOES NOT WORK WITH I<-a> ETC. OPTIONS
+
+Options such as I<-a>, I<--add>, I<-N>, I<--new> etc don't interact
+properly with remote support.  They are processed locally, and not
+sent through to the remote guestfish.  In particular this won't do
+what you expect:
+
+ guestfish --remote --add disk.img
+
+Don't use these options.  Use the equivalent commands instead, eg:
+
+ guestfish --remote add-drive disk.img
+
+or:
+
+ guestfish --remote
+ ><fs> add disk.img
+
 =head2 REMOTE CONTROL RUN COMMAND HANGING
 
 Using the C<run> (or C<launch>) command remotely in a command
-- 
1.8.3.1