summary refs log tree commit diff
diff options
context:
space:
mode:
authorBastian Köcher <git@kchr.de>2017-11-23 15:06:32 +0100
committerBastian Köcher <git@kchr.de>2017-11-23 15:50:54 +0100
commit1200f9b9e268bce0f9753b15fbd4302b32cb6c26 (patch)
tree3ebfc44f5166a47832b55ba5a08af96baa9a469e
parent852acd8bafd49f1612838fb377396eda1243652c (diff)
downloadnixlib-1200f9b9e268bce0f9753b15fbd4302b32cb6c26.tar
nixlib-1200f9b9e268bce0f9753b15fbd4302b32cb6c26.tar.gz
nixlib-1200f9b9e268bce0f9753b15fbd4302b32cb6c26.tar.bz2
nixlib-1200f9b9e268bce0f9753b15fbd4302b32cb6c26.tar.lz
nixlib-1200f9b9e268bce0f9753b15fbd4302b32cb6c26.tar.xz
nixlib-1200f9b9e268bce0f9753b15fbd4302b32cb6c26.tar.zst
nixlib-1200f9b9e268bce0f9753b15fbd4302b32cb6c26.zip
Adds missing documentation for copyFileFromHost in NixOS tests
-rw-r--r--nixos/doc/manual/development/writing-nixos-tests.xml12
1 files changed, 11 insertions, 1 deletions
diff --git a/nixos/doc/manual/development/writing-nixos-tests.xml b/nixos/doc/manual/development/writing-nixos-tests.xml
index b9da712b86f0..7b25a39e83b8 100644
--- a/nixos/doc/manual/development/writing-nixos-tests.xml
+++ b/nixos/doc/manual/development/writing-nixos-tests.xml
@@ -262,8 +262,18 @@ startAll;
     <literal>waitForWindow(qr/Terminal/)</literal>.</para></listitem>
   </varlistentry>
 
+  <varlistentry>
+    <term><methodname>copyFileFromHost</methodname></term>
+    <listitem><para>Copies a file from host to machine, e.g.,
+    <literal>copyFileFromHost("myfile", "/etc/my/important/file")</literal>.</para>
+    <para>The first argument is the file on the host. The file needs to be
+    accessible while building the nix derivation. The second argument is
+    the location of the file on the machine.</para>
+    </listitem>
+  </varlistentry>
+
 </variablelist>
 
 </para>
 
-</section>
\ No newline at end of file
+</section>