nixos/tests/test-driver: document shell_interact

(cherry picked from commit 9469433e341f7337308468bb4b9ccfff84b2951b)
2021-06-03 09:49:17 +00:00
parent e3e37d20ce
commit 9046996543
2 changed files with 12 additions and 1 deletions
@@ -436,6 +436,17 @@ machine.systemctl("list-jobs --no-pager", "any-user") # spawns a shell for `any-
     </para>
    </listitem>
   </varlistentry>
+   <varlistentry>
+    <term>
+     <methodname>shell_interact</methodname>
+    </term>
+    <listitem>
+     <para>
+      Allows you to directly interact with the guest shell.
+      This should only be used during test development, not in production tests.
+     </para>
+    </listitem>
+   </varlistentry>
  </variablelist>
 </para>