All other result plugins write (by default) to the job results dir.
The HTML plugin was different because it used to require a number of
files.  Now, it's a single file, and thus, could/should live in the
same place as other files.

To ease the transition of the location, let's add a symlink, so that
users can still rely on the old location.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

This section should help people running 36.x to move towards using 52.x
Avocado version.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

Words like JSON and YAML are acronyms, and should be written
using capital letters only.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The yaml_to_mux plugin may be able to read JSON files, but this not
documented *at all* and conflicts even with the basic help information
given on yaml_to_mux.  Let's omit that until we decide if JSON should
be treated by Avocado as a valid input to yaml_to_mux.

Then, while at it, a hopefully clearer version, broken down into
smaller sentences, is being proposed.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

* https://github.com/avocado-framework/avocado:
  Docs: document the test process environment
  Docs: AVOCADO_* environment variables are available to all tests

Each test executed in Avocado gets its own process.  But, there are a
few peculiarities that test writers may have to deal with, so let's
document those.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

And not only to SIMPLE tests.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

When Varianter plugins report no variants, default is provided by
Varianter on `itertests`. The same needs to be emulated in case of
`to_str`, otherwise users would not get the same results as during
`run`.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

We are about to need human readable variant representation outside the
`mux` module, let's create a generic implementation based on that one to
allow people to re-use it.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The `--system-wide` option's destination is "variants-skip-defaults" and
not "variants_skip_defaults" due which this option did not actually
work.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

* https://github.com/avocado-framework/avocado:
  Docs: add section on pre/post job and pre/post tests

Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

* https://github.com/avocado-framework/avocado:
  docs: Add LTS releases section and 52 what's new page

We were lacking a clearer explanation on the pre/post job and pre/post
tests interface.  When they're executed, and under which conditions
they'll be attempted.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

Let's create a section to have the 'what's new' between LTSs and
add the next known LTS page there.
Signed-off-by: NAmador Pahim <apahim@redhat.com>

Currently there are two types of plugin names, one is the fully
qualified plugin name, which is the namespace used by stevedore and the
other is the module name, which is the module which handles the code.
It's probably too late to adjust the behavior, but let's at least
provide correct examples to simplify the usage.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

* https://github.com/avocado-framework/avocado:
  docs: improve the docs regarding the test references

Let's add some extra information and some examples about the test
references.

Reference: https://trello.com/c/iJlNcBafSigned-off-by: NAmador Pahim <apahim@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Currently the results are spread into multiple files, which does not
work nicely when results are compressed and only the result.html is
uncompressed. Let's embed everything into `result.html` to make things
easier.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Let's document the aspects of a code review in Avocado.
Signed-off-by: NAmador Pahim <apahim@redhat.com>

The examples/mux-* yaml files are intended for use in selftests, but
they lived for a long time directly in examples. Let's move them to
proper place to avoid unnecessary confusion to newcomers.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

We used to be abusing selftest-oriented yaml files to demonstrate
varianter, let's add few user-oriented examples directly here (in
addition to already existing `example/tests/*.data/*.yaml`.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

Let's use the latest version of the LTS RFC, from the docs themselves.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

New optional plugins are now available, and some in RPM package
format.  Let's include them where plugin RPM packages are listed.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Let's include an empty line between the plugin categories, so it's
easier to distinguish between different plugin types.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

There's a problem with assuming that all existing plugins will
be setup at API docs creation time, initially on RPM builds but
could also happen on systems that lack dependencies for some of
the plugins.

Let's only build docs for those that have been properly setup
and are available to be imported.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Including additions of words to ignore, and substitution of words
we better keep off the ignore list.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

With two different versions of pylint, style warnings were reported:

 avocado/core/loader.py:662:20: W503 line break before binary operator
 avocado/core/loader.py:668:20: W503 line break before binary operator
 avocado/core/loader.py:676:20: W503 line break before binary operator

Let's fix by breaking that into two statements.
Signed-off-by: NCleber Rosa <crosa@redhat.com>