Skip to content

Commit b76fe76

Browse files
authored
Merge pull request #665 from vkarak/doc/verbose-option
[doc] Document verbosity option
2 parents fc51109 + ea8f316 commit b76fe76

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

docs/running.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -829,6 +829,20 @@ The ReFrame's ``graylog`` handler sends log messages in JSON format using an HTT
829829
More details on this log format may be found `here <http://docs.graylog.org/en/latest/pages/gelf.html#gelf-payload-specification>`__.
830830

831831

832+
Adjusting verbosity of output
833+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
834+
835+
ReFrame's output is handled by a logging mechanism.
836+
In fact, as revealed in the corresponding configuration entry (see `Configuring Logging <#configuring-logging>`__), a specific logging handler takes care of printing ReFrame's message in the standard output.
837+
One way to change the verbosity level of the output is by explicitly setting the value of the ``level`` key in the configuration of the output handler.
838+
Alternatively, you may increase the verbosity level from the command line by chaining the ``-v`` or ``--verbose`` option.
839+
Every time ``-v`` is specified, the next verbosity level will be selected for the output.
840+
For example, if the initial level of the output handler is set to ``INFO`` (in the configuration file), specifying ``-v`` twice will make ReFrame spit out all ``DEBUG`` messages.
841+
842+
.. versionadded:: 2.16
843+
``-v`` and ``--verbose`` options are added.
844+
845+
832846
Asynchronous Execution of Regression Checks
833847
-------------------------------------------
834848

reframe/frontend/cli.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,6 @@ def main():
8787
'--save-log-files', action='store_true', default=False,
8888
help='Copy the log file from the work dir to the output dir at the '
8989
'end of the program')
90-
output_options.add_argument(
91-
'--verbose', '-v', action='count', default=0,
92-
help='Increase verbosity level of output')
9390

9491
# Check discovery options
9592
locate_options.add_argument(
@@ -230,6 +227,8 @@ def main():
230227
help='Print configuration of environment ENV and exit')
231228
misc_options.add_argument('-V', '--version', action='version',
232229
version=reframe.VERSION)
230+
misc_options.add_argument('-v', '--verbose', action='count', default=0,
231+
help='Increase verbosity level of output')
233232

234233
if len(sys.argv) == 1:
235234
argparser.print_help()

0 commit comments

Comments
 (0)