summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml37
1 files changed, 11 insertions, 26 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 4a3c020b83..dc61170fbf 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -6009,35 +6009,20 @@
6009 for copying on the target such as small 6009 for copying on the target such as small
6010 files written in C for compilation. 6010 files written in C for compilation.
6011 </para></listitem> 6011 </para></listitem>
6012 <listitem><para><emphasis><filename>qemu</filename>:</emphasis>
6013 Provides access to the
6014 <filename>QemuRunner</filename> object,
6015 which is the class that boots the image.
6016 The <filename>qemu</filename> attribute
6017 provides the following useful attributes:
6018 <itemizedlist>
6019 <listitem><para><emphasis><filename>ip</filename>:</emphasis>
6020 The machine's IP address.
6021 </para></listitem>
6022 <listitem><para><emphasis><filename>host_ip</filename>:</emphasis>
6023 The host IP address, which is only
6024 used by smart tests.
6025 </para></listitem>
6026 </itemizedlist></para></listitem>
6027 <listitem><para><emphasis><filename>target</filename>:</emphasis> 6012 <listitem><para><emphasis><filename>target</filename>:</emphasis>
6028 The <filename>SSHControl</filename> object, 6013 The target controller object used to deploy
6029 which is used for running the following 6014 and start an image on a particular target
6030 commands on the image: 6015 (e.g. QemuTarget, SimpleRemote, and
6016 GummibootTarget).
6017 Tests usually use the following:
6031 <itemizedlist> 6018 <itemizedlist>
6032 <listitem><para><emphasis><filename>host</filename>:</emphasis> 6019 <listitem><para><emphasis><filename>ip</filename>:</emphasis>
6033 Used internally. 6020 The target's IP address.
6034 The tests do not use this command.
6035 </para></listitem> 6021 </para></listitem>
6036 <listitem><para><emphasis><filename>timeout</filename>:</emphasis> 6022 <listitem><para><emphasis><filename>server_ip</filename>:</emphasis>
6037 A global timeout for commands run on 6023 The host's IP address, which is
6038 the target for the instance of a 6024 usually used by the "smart" test
6039 test. 6025 suite.
6040 The default is 300 seconds.
6041 </para></listitem> 6026 </para></listitem>
6042 <listitem><para><emphasis><filename>run(cmd, timeout=None)</filename>:</emphasis> 6027 <listitem><para><emphasis><filename>run(cmd, timeout=None)</filename>:</emphasis>
6043 The single, most used method. 6028 The single, most used method.