summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-10-28 09:48:17 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-10-28 22:31:17 +0000
commit0761eba74dbde2c3eecc13cbca1cccfce1f0fcd7 (patch)
treea5d1346f8b5aab1e63ee7ba5621296d211892a8c /documentation/ref-manual/ref-variables.xml
parent9908d9ed0043e998b2ac4b599ab9aae62f740d6b (diff)
downloadpoky-0761eba74dbde2c3eecc13cbca1cccfce1f0fcd7.tar.gz
ref-manual: Added some new test variables:
* TEST_SERIALCONTROL_CMD * TEST_SERIALCONTROL_EXTRA_ARGS * TEST_POWERCONTROL_CMD * TEST_POWERCONTROL_EXTRA_ARGS (From yocto-docs rev: 25f196cc03178f07201ef183fb309721d412e971) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml68
1 files changed, 68 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index a14d67bfd9..b22c661421 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -9122,6 +9122,37 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9122 </glossdef> 9122 </glossdef>
9123 </glossentry> 9123 </glossentry>
9124 9124
9125 <glossentry id='var-TEST_POWERCONTROL_CMD'><glossterm>TEST_POWERCONTROL_CMD</glossterm>
9126 <glossdef>
9127 <para>
9128 For automated hardware testing, specifies the command to
9129 use to control the power of the target machine under test.
9130 Typically, this command would point to a script that
9131 performs the appropriate action (e.g. interacting
9132 with a web-enabled power strip).
9133 The specified command should expect to receive as the last
9134 argument "off", "on" or "cycle" specifying to power off,
9135 on, or cycle (power off and then power on) the device,
9136 respectively.
9137 </para>
9138 </glossdef>
9139 </glossentry>
9140
9141 <glossentry id='var-TEST_POWERCONTROL_EXTRA_ARGS'><glossterm>TEST_POWERCONTROL_EXTRA_ARGS</glossterm>
9142 <glossdef>
9143 <para>
9144 For automated hardware testing, specifies additional
9145 arguments to pass through to the command specified in
9146 <link linkend='var-TEST_POWERCONTROL_CMD'><filename>TEST_POWERCONTROL_CMD</filename></link>.
9147 Setting <filename>TEST_POWERCONTROL_EXTRA_ARGS</filename>
9148 is optional.
9149 You can use it if you wish, for example, to separate the
9150 machine-specific and non-machine-specific parts of the
9151 arguments.
9152 </para>
9153 </glossdef>
9154 </glossentry>
9155
9125 <glossentry id='var-TEST_QEMUBOOT_TIMEOUT'><glossterm>TEST_QEMUBOOT_TIMEOUT</glossterm> 9156 <glossentry id='var-TEST_QEMUBOOT_TIMEOUT'><glossterm>TEST_QEMUBOOT_TIMEOUT</glossterm>
9126 <glossdef> 9157 <glossdef>
9127 <para> 9158 <para>
@@ -9142,6 +9173,43 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9142 </glossdef> 9173 </glossdef>
9143 </glossentry> 9174 </glossentry>
9144 9175
9176 <glossentry id='var-TEST_SERIALCONTROL_CMD'><glossterm>TEST_SERIALCONTROL_CMD</glossterm>
9177 <glossdef>
9178 <para>
9179 For automated hardware testing, specifies the command
9180 to use to connect to the serial console of the target
9181 machine under test.
9182 This command simply needs to connect to the serial console
9183 and forward that connection to standard input and output
9184 as any normal terminal program does.
9185 </para>
9186
9187 <para>
9188 For example, to use the Picocom terminal program on
9189 serial device <filename>/dev/ttyUSB0</filename> at
9190 115200bps, you would set the variable as follows:
9191 <literallayout class='monospaced'>
9192 TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200"
9193 </literallayout>
9194 </para>
9195 </glossdef>
9196 </glossentry>
9197
9198 <glossentry id='var-TEST_SERIALCONTROL_EXTRA_ARGS'><glossterm>TEST_SERIALCONTROL_EXTRA_ARGS</glossterm>
9199 <glossdef>
9200 <para>
9201 For automated hardware testing, specifies additional
9202 arguments to pass through to the command specified in
9203 <link linkend='var-TEST_SERIALCONTROL_CMD'><filename>TEST_SERIALCONTROL_CMD</filename></link>.
9204 Setting <filename>TEST_SERIALCONTROL_EXTRA_ARGS</filename>
9205 is optional.
9206 You can use it if you wish, for example, to separate the
9207 machine-specific and non-machine-specific parts of the
9208 command.
9209 </para>
9210 </glossdef>
9211 </glossentry>
9212
9145 <glossentry id='var-TEST_SERVER_IP'><glossterm>TEST_SERVER_IP</glossterm> 9213 <glossentry id='var-TEST_SERVER_IP'><glossterm>TEST_SERVER_IP</glossterm>
9146 <glossdef> 9214 <glossdef>
9147 <para> 9215 <para>