about summary refs log tree commit diff
path: root/nixos/doc/manual/development/writing-nixos-tests.xml
diff options
context:
space:
mode:
Diffstat (limited to 'nixos/doc/manual/development/writing-nixos-tests.xml')
-rw-r--r--nixos/doc/manual/development/writing-nixos-tests.xml8
1 files changed, 6 insertions, 2 deletions
diff --git a/nixos/doc/manual/development/writing-nixos-tests.xml b/nixos/doc/manual/development/writing-nixos-tests.xml
index 322778d1c209..b9da712b86f0 100644
--- a/nixos/doc/manual/development/writing-nixos-tests.xml
+++ b/nixos/doc/manual/development/writing-nixos-tests.xml
@@ -158,7 +158,9 @@ startAll;
     <term><methodname>getScreenText</methodname></term>
     <listitem><para>Return a textual representation of what is currently
     visible on the machine's screen using optical character
-    recognition.</para></listitem>
+    recognition.</para>
+    <note><para>This requires passing <option>enableOCR</option> to the test
+    attribute set.</para></note></listitem>
   </varlistentry>
 
   <varlistentry>
@@ -248,7 +250,9 @@ startAll;
     <term><methodname>waitForText</methodname></term>
     <listitem><para>Wait until the supplied regular expressions matches
     the textual contents of the screen by using optical character recognition
-    (see <methodname>getScreenText</methodname>).</para></listitem>
+    (see <methodname>getScreenText</methodname>).</para>
+    <note><para>This requires passing <option>enableOCR</option> to the test
+    attribute set.</para></note></listitem>
   </varlistentry>
 
   <varlistentry>