Skip to content

Commit

Permalink
Updated the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Hook25 committed Oct 6, 2023
1 parent d00857f commit a2d1830
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions docs/tutorial/using-checkbox/launcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,8 +244,8 @@ and where it comes from. Run the following command:

.. code-block:: none
$ checkbox.checkbox-cli check-config
Configuration files:
$ checkbox.checkbox-cli check-config
Configuration files:
- /var/snap/checkbox/2799/checkbox.conf
- /home/user/.config/checkbox.conf
[config]
Expand Down Expand Up @@ -286,6 +286,43 @@ environment variable is set to ``120`` because it is specified in
a Checkbox configuration that comes with the snap version I'm using
(``/var/snap/checkbox/2799/checkbox.conf``).

If you want to debug a Checkbox run that involves a ``launcher``, fear not.
The ``check-config`` command works with launchers as well. Try the previous
command with the ``launcher`` we created before:

.. code-block:: none
:emphasize-lines: 8,14,17-18,21,28
$ checkbox.checkbox-cli check-config mylauncher
Configuration files:
- /var/snap/checkbox/2799/checkbox.conf
- /home/user/.config/checkbox.conf
[config]
config_filename=checkbox.conf (Default)
[launcher]
app_id=com.canonical.certification:tutorial From config file: /home/user/mylauncher
app_version= (Default)
launcher_version=1 From config file: /home/user/.config/checkbox.conf
local_submission=True (Default)
session_desc= (Default)
session_title=session title (Default)
stock_reports=text, submission_files From config file: /home/user/mylauncher
[test plan]
filter=* (Default)
forced=True From config file: /home/user/mylauncher
unit=com.canonical.certification::tutorial-base From config file: /home/user/mylauncher
[test selection]
exclude= (Default)
forced=True From config file: /home/user/mylauncher
(...)
[environment]
STRESS_S3_WAIT_DELAY=120 From config file: /var/snap/checkbox/2799/checkbox.conf
(...)
TUTO=tutorial From config file: /home/user/.config/checkbox.conf
(...)
TUTORIAL=Value from my launcher! From config file: /home/user/mylauncher
No problems with config(s) found!
Create an executable launcher
=============================

Expand Down

0 comments on commit a2d1830

Please sign in to comment.