← Back to branch summary

~pieq/checkbox/add-30suspend-1reboot-cycles-support

« back to all changes in this revision

Viewing changes to checkbox-ng/docs/profiles.rst

  • Committer: Daniel Manrique
  • Author(s): Zygmunt Krynicki
  • Date: 2014-04-24 15:22:16 UTC
  • mfrom: (2938.2.7 launchpad/fix-1307800)
  • Revision ID: daniel_manrique-20140424152216-gmbtdzei8zv98p1t
"automatic merge by tarmac [r=zkrynicki][bug=1307800][author=zkrynicki]"

Show diffs side-by-side

added added

removed removed

Lines of Context:
checkbox-ng/docs/profiles.rst
2
2
^^^^^^^^^^^^^^^^^^^^^^
3
3
 
4
4
Checkbox-gui supports execution profiles via a predefined set of configuration
5
 
options that allow customization of the welcome screen, displayed whitelists
6
 
as well as saving results locally or sending the submission file to Launchpad
7
 
or to the Certification database/HEXR. 
 
5
options that allow customization of the welcome screen, displayed whitelists as
 
6
well as saving results locally or sending the submission file to Launchpad or
 
7
to the Certification database/HEXR.
8
8
 
9
9
The profile settings are part of a launcher script and use checkbox-gui as a
10
10
shebang to interpret the key/values.
12
12
As checkbox-gui is a Qt application, settings must follow the INI-style rules
13
13
of the `QSettings <http://qt-project.org/doc/qt-5/QSettings.html>`_ class.
14
14
 
15
 
Multilines values are supported but must be enclosed in doubles quotes and extra
16
 
lines must start with one space, e.g:
 
15
Multiple-line values are supported but must be enclosed in doubles quotes and
 
16
extra lines must start with one space, e.g:
17
17
 
18
18
.. code-block:: bash
19
19
 
38
38
==================
39
39
 
40
40
welcome/title
41
 
------------
42
 
 * QML app title and welcome screen header
43
 
 * default: "System Testing"
 
41
-------------
 
42
 
 
43
QML application title and welcome screen header. Defaults to ``System
 
44
Testing``.
44
45
 
45
46
welcome/text
46
47
------------
47
 
 * Welcome message to display on the first screen (Rich text allowing HTML-style markup)
48
 
 * default: "<p>Welcome to System Testing.</p> [...]"
 
48
 
 
49
Welcome message to display on the first screen (Rich text allowing HTML-style
 
50
markup). Defaults to ``<p>Welcome to System Testing.</p> [...]``
49
51
 
50
52
suite/whitelist_filter
51
53
----------------------
52
 
 * Regular expression to match a subset of whitelist filenames
53
 
 * default: .*
 
54
 
 
55
Regular expression to match a subset of whitelist filenames. Defaults to ``.*``
54
56
 
55
57
submission/message
56
58
------------------
57
 
 * Header text of the Submission Popup
 
59
 
 
60
Header text of the submission pop-up
58
61
 
59
62
submission/input_type
60
63
---------------------
61
 
 * Show a Text input field to enter the secure ID or the LP adress (default).
62
 
   To just save the results to disk, must use the "none" value.
 
64
 
 
65
Show a Text input field to enter the secure ID or the LP address (default). 
 
66
To just save the results to disk, must use the ``none`` value.
63
67
 
64
68
submission/regex
65
 
----------
66
 
 * RegExpValidator, default ".*"
 
69
----------------
 
70
 
 
71
RegExpValidator, default ``.*``
67
72
 
68
73
submission/input_placeholder
69
74
----------------------------
70
 
 * "Launchpad E-Mail Address" (default) or "Secure ID (15 or 18 characters)" 
 
75
 
 
76
``Launchpad E-Mail Address`` (default) or ``Secure ID (15 or 18 characters)``
71
77
 
72
78
submission/secure_id
73
79
--------------------
74
 
 * Preset value of the secure ID
 
80
 
 
81
Preset value of the secure ID
75
82
 
76
83
submission/ok_btn_text
77
84
----------------------
78
 
 * "Submit Results" (default) or "Save Results"
 
85
 
 
86
``Submit Results`` (default) or ``Save Results``
79
87
 
80
88
submission/cancel_warning
81
89
-------------------------
82
 
 * "You are about to exit this test run without saving your results report.  Do you want to save the report?"
 
90
 
 
91
You are about to exit this test run without saving your results report. Do you
 
92
want to save the report?
83
93
 
84
94
submission/submit_to_hexr
85
95
-------------------------
86
 
 * Boolean, add an extra header to also send the results to HEXR (works with
87
 
   the certification transport)
 
96
 
 
97
Boolean, add an extra header to also send the results to HEXR (works with the
 
98
certification transport)
88
99
 
89
100
exporter/xml_export_path
90
101
------------------------
91
 
 * location to save the XML submission file, if set to an empty string will open a FileSaveDialog.
92
 
 * default: "/tmp/submission.xml"
 
102
 
 
103
Location to save the XML submission file, if set to an empty string will open a
 
104
file save dialog. Default: ``/tmp/submission.xml``
93
105
 
94
106
transport/submit_to
95
107
-------------------
96
 
 *  Transport endpoint
97
 
 *  default: ""
98
 
 *  Supports submission to LP (the default), "certification", or "local" (save to disk)
 
108
 
 
109
Transport endpoint. Defaults to ``<none>``.  Supports submission to LP (the
 
110
default), ``certification``, or ``local`` (save to disk)