01/01: doc: Add note about private-key during offload.

[Ludovic Courtès]

civodul pushed a commit to branch master
in repository guix.

commit dde1e152ce42a06fe2998f3da8acb1addfd296fc
Author: Oleg Pykhalov <address@hidden>
Date:   Fri Jul 7 23:25:40 2017 +0300

    doc: Add note about private-key during offload.
    
    * doc/guix.texi (Using the Offload Facility): Add note about private-key.
    
    Co-authored-by: Ludovic Courtès <address@hidden>
---
 doc/guix.texi | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index eab1704..cd694bb 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -943,10 +943,13 @@ A number of optional fields may be specified:
 @item @code{port} (default: @code{22})
 Port number of SSH server on the machine.
 
address@hidden @code{private-key} (default: @file{~/.ssh/id_rsa})
address@hidden @code{private-key} (default: @file{~root/.ssh/id_rsa})
 The SSH private key file to use when connecting to the machine, in
 OpenSSH format.
 
+Note that the default value is the private key @emph{of the root
+account}.  Make sure it exists if you use the default.
+
 @item @code{compression} (default: @code{"zlib@@openssh.com,zlib"})
 @itemx @code{compression-level} (default: @code{3})
 The SSH-level compression methods and compression level requested.