Skip to content

Commit

Permalink
Merge pull request avocado-framework#5792 from wsakernel/doc-fixes-fo…
Browse files Browse the repository at this point in the history
…r-installing

Signed-off-by: Jan Richter <[email protected]>
  • Loading branch information
richtja authored Nov 3, 2023
2 parents caf1e0c + 1b9f9dc commit ffc3c42
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 16 deletions.
6 changes: 3 additions & 3 deletions avocado/core/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@
default value as argument. Developers only need to register the default
value once, here when calling this methods.
2. User/System configuration files (/etc/avocado or ~/.avocado/): This is
configured by the user, on a more "permanent way".
2. System/User configuration files (/etc/avocado or ~/.config/avocado/): This
is configured by the user, in a more "permanent way".
3. Command-line options parsed in runtime. This is configured by the user, on
3. Command-line options parsed in runtime. This is configured by the user, in
a more "temporary way";
"""

Expand Down
19 changes: 9 additions & 10 deletions docs/source/guides/user/chapters/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,19 +125,18 @@ Then to install Avocado from the git repository run::

$ git clone git://github.com/avocado-framework/avocado.git
$ cd avocado
$ python3 setup.py install --user
$ pip install . --user

Optionally, to install the plugins run::
To install an optional plugin run::

$ python3 setup.py plugin --install=golang --user
$ python3 setup.py plugin --install=html --user
$ python3 setup.py plugin --install=result_upload --user
$ python3 setup.py plugin --install=resultsdb --user
$ python3 setup.py plugin --install=robot --user
$ python3 setup.py plugin --install=varianter_cit --user
$ python3 setup.py plugin --install=varianter_pict --user
$ python3 setup.py plugin --install=varianter_yaml_to_mux --user
$ pip install optional_plugins/<plugin_name> --user

I.e. for the HTML plugin::

$ pip install optional_plugins/html --user

Check the directory ``optional_plugins`` for additional features you might be
interested in.

.. _Virtualization:Tests project in OpenSUSE build service: https://build.opensuse.org/project/show/Virtualization:Tests
.. _Avocado-VT: https://avocado-vt.readthedocs.io/en/latest/GetStartedGuide.html#installing-avocado-vt
6 changes: 3 additions & 3 deletions docs/source/guides/user/chapters/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -526,6 +526,6 @@ sysinfo on ``pre``, but saves only changed ones on ``post``. It is set to
False by default.

.. warning:: If you are using Avocado from sources, you need to manually place
the ``commands``/``fail_commands``/``fail_files``/``files``/``profilers``
into the ``/etc/avocado/sysinfo`` directories or adjust the paths in
``$AVOCADO_SRC/etc/avocado/avocado.conf``.
``commands``/``fail_commands``/``fail_files``/``files``/``profilers`` into
the ``/etc/avocado/sysinfo`` directory or adjust the paths in your
``avocado.conf``.

0 comments on commit ffc3c42

Please sign in to comment.