提交 fe38588b 编写于 作者: L Lukáš Doktor

docs: Several minor fixes

Some spelling issues, broken link fixes and updates related to recent
changes in Avocado.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>
上级 3c6e34e3
......@@ -151,7 +151,7 @@ provided, it will fall back to (we hope) reasonable defaults, and we
notify the user about that in the output of the command.
The relevant API documentation and meaning of each of those data directories
is in :mod:`avocado.data_dir`, so it's highly recommended you take a look.
is in :mod:`avocado.core.data_dir`, so it's highly recommended you take a look.
You may set your preferred data dirs by setting them in the Avocado config files.
The only exception for important data dirs here is the Avocado tmp dir, used to
......
......@@ -121,6 +121,7 @@ plugin::
$ avocado run sleeptest.py failtest.py synctest.py --json -
{
"cancel": 0,
"debuglog": "/home/cleber/avocado/job-results/job-2016-08-09T13.53-10715c4/job.log",
"errors": 0,
"failures": 1,
......@@ -197,8 +198,9 @@ Provides the basic `TAP <http://testanything.org/>`__ (Test Anything Protocol) r
Silent result
~~~~~~~~~~~~~
While not a very fancy result format, an application may want nothing but
the exit status code from an Avocado test job run. Example::
This result disables all stdout logging (while keeping the error messages
being printed to stderr). One can then use the return code to learn about
the result::
$ avocado --silent run failtest.py
$ echo $?
......
......@@ -50,7 +50,7 @@ Optionally, you may have password less SSH login on your remote machine enabled.
Running your test
-----------------
Once the remote machine is properly setup, you may run your test. Example::
Once the remote machine is properly set, you may run your test. Example::
$ scripts/avocado run --remote-hostname 192.168.122.30 --remote-username fedora examples/tests/sleeptest.py examples/tests/failtest.py
REMOTE LOGIN : fedora@192.168.122.30:22
......@@ -63,7 +63,7 @@ Once the remote machine is properly setup, you may run your test. Example::
A bit of extra logging information is added to your job summary, mainly
to distinguish the regular execution from the remote one. Note here that
we did not need `--remote-password` because an SSH key was already setup.
we did not need `--remote-password` because an SSH key was already set.
Running Tests on a Virtual Machine
==================================
......@@ -126,7 +126,7 @@ Optionally, you may have password less SSH login on your VM enabled.
Running your test
-----------------
Once the virtual machine is properly setup, you may run your test. Example::
Once the virtual machine is properly set, you may run your test. Example::
$ scripts/avocado run --vm-domain fedora20 --vm-username autotest --vm examples/tests/sleeptest.py examples/tests/failtest.py
VM DOMAIN : fedora20
......@@ -140,7 +140,7 @@ Once the virtual machine is properly setup, you may run your test. Example::
A bit of extra logging information is added to your job summary, mainly
to distinguish the regular execution from the remote one. Note here that
we did not need `--vm-password` because the SSH key is already setup.
we did not need `--vm-password` because the SSH key is already set.
Running Tests on a Docker container
===================================
......@@ -199,7 +199,7 @@ container::
Running your test
-----------------
Assuming your system is properly setup to run Docker, including having
Assuming your system is properly set to run Docker, including having
an image with Avocado, you can run a test inside the container with a
command similar to::
......
......@@ -7,11 +7,6 @@ Test parameters
basics, see :ref:`accessing-test-parameters` or practical view by examples
in `Yaml_to_mux plugin`_.
.. warning:: The multiplexer is under heavy refactor and some of the APIs
might still change in the following months (written on 2016-01-22),
then we'll do our best to keep the public interfaces as stable as
possible.
Avocado allows passing parameters to tests, which effectively results in
several different variants of each test. These parameters are available in
(test's) ``self.params`` and are of
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册