summary refs log tree commit diff
diff options
context:
space:
mode:
authorGraham Christensen <graham@grahamc.com>2017-11-23 19:50:39 -0500
committerGitHub <noreply@github.com>2017-11-23 19:50:39 -0500
commit0726cd6f0c8e8d288c2da058cb3174154832ec73 (patch)
tree6bee12aac75ae9d80ace06b29dc5bea795d92d60
parent9c048f4fb66adc33c6b379f2edefcb615fd53de6 (diff)
parent1200f9b9e268bce0f9753b15fbd4302b32cb6c26 (diff)
downloadnixlib-0726cd6f0c8e8d288c2da058cb3174154832ec73.tar
nixlib-0726cd6f0c8e8d288c2da058cb3174154832ec73.tar.gz
nixlib-0726cd6f0c8e8d288c2da058cb3174154832ec73.tar.bz2
nixlib-0726cd6f0c8e8d288c2da058cb3174154832ec73.tar.lz
nixlib-0726cd6f0c8e8d288c2da058cb3174154832ec73.tar.xz
nixlib-0726cd6f0c8e8d288c2da058cb3174154832ec73.tar.zst
nixlib-0726cd6f0c8e8d288c2da058cb3174154832ec73.zip
Merge pull request #31972 from bkchr/copyfilefromhost_missing_documentation
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>