Skip to content

Commit 1e6be58

Browse files
author
Vasileios Karakasis
committed
Document support of the %:z time format directive
1 parent f8c3413 commit 1e6be58

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/running.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -849,7 +849,7 @@ All handlers accept the following set of attributes (keys) in their configuratio
849849

850850
* ``level``: (default: ``DEBUG``) The lowest level of log records that this handler can process.
851851
* ``format`` (default: ``'%(message)s'``): Format string for the printout of the log record.
852-
ReFrame supports all the `format strings <https://docs.python.org/3.6/library/logging.html#logrecord-attributes>`__ from Python's logging library and provides the following additional ones:
852+
ReFrame supports all the `log record attributes <https://docs.python.org/3.6/library/logging.html#logrecord-attributes>`__ from Python's logging library and provides the following additional ones:
853853

854854
- ``check_environ``: The programming environment a test is currently executing for.
855855
- ``check_info``: Print live information of the currently executing check.
@@ -877,15 +877,20 @@ All handlers accept the following set of attributes (keys) in their configuratio
877877
- ``osgroup``: The group name of the OS user running ReFrame.
878878
- ``version``: The ReFrame version.
879879

880-
* ``datefmt`` (default: ``'%FT%T'``) The format that will be used for outputting timestamps (i.e., the ``%(asctime)s`` field).
881-
Acceptable formats must conform to standard library's `time.strftime() <https://docs.python.org/3.6/library/time.html#time.strftime>`__ function.
880+
* ``datefmt`` (default: ``'%FT%T'``) The format that will be used for outputting timestamps (i.e., the ``%(asctime)s`` and the ``%(check_job_completion_time)s`` fields).
881+
In addition to the format directives supported by the standard library's `time.strftime() <https://docs.python.org/3.6/library/time.html#time.strftime>`__ function, ReFrame allows you to use the ``%:z`` directive -- a GNU ``date`` extension -- that will print the time zone difference in a RFC3339 compliant way, i.e., ``+/-HH:MM`` instead of ``+/-HHMM``.
882882

883883
.. caution::
884884
The ``testcase_name`` logging attribute is replaced with the ``check_info``, which is now also configurable
885885

886886
.. versionchanged:: 2.10
887887

888888

889+
.. note::
890+
Support for fully RFC3339 compliant time zone formatting.
891+
892+
.. versionadded:: 3.0
893+
889894

890895
File log handlers
891896
"""""""""""""""""

0 commit comments

Comments
 (0)