From c7f9214c8e097f27fffa38b4b7c0b0042c9d9034 Mon Sep 17 00:00:00 2001 From: Chandan Singh Date: Mon, 3 Aug 2020 21:49:14 +0000 Subject: data/userconfig.yaml: Document valid symbols for format strings Document the valid symbols that can be used as part of the `message-format`. And, in case of `element-format`, redirect to `bst show --help` to avoid duplicating the help text in two places. Fixes #510. --- src/buildstream/data/userconfig.yaml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/buildstream/data/userconfig.yaml b/src/buildstream/data/userconfig.yaml index 5b568167b..d6f91ef66 100644 --- a/src/buildstream/data/userconfig.yaml +++ b/src/buildstream/data/userconfig.yaml @@ -125,11 +125,26 @@ logging: # Format string for printing the pipeline at startup, this # also determines the default display format for `bst show` + # + # See `bst show --help` for details on which symbols can be + # used in the format string. element-format: | %{state: >12} %{full-key} %{name} %{workspace-dirs} # Format string for all log messages. + # + # Following symbols can be used in the format string: + # + # elapsed - Time spent on this operation + # elapsed-us - Time spent on this operation (with microsecond precision) + # wallclock - Current wallclock time + # wallclock-us - Current wallclock time (with microsecond precision) + # key - The abbreviated cache key (if all sources are consistent) + # element - Name of the element + # action - Type of the message + # message - The main message text + # message-format: | [%{elapsed}][%{key}][%{element}] %{action} %{message} -- cgit v1.2.1