summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSandrine Bailleux <sandrine.bailleux@arm.com>2014-11-18 13:57:05 +0000
committerSandrine Bailleux <sandrine.bailleux@arm.com>2014-11-24 14:56:54 +0000
commitd53a9b885a93af73f8d3ee6408902ef756a8c4d6 (patch)
tree45189f366f84fb0c824ab8ceaf1737c23768dfc8 /docs
parentd5472878d74e1a563576c4d5781dac906924af58 (diff)
Add support to use shell colors to distinguish CPUs' messages
Introduce a new build flag `SHELL_COLOR`. It can take either 0 (disabled) or 1 (enabled) as values. 0 is the default. If set to 1, text messages printed using mp_printf() will use shell's color escape sequences to ease identifying which CPU displays it. This is intended as a debug feature. Change-Id: I91a4128d2f854cd5cb259fb23802d0158e2035fe
Diffstat (limited to 'docs')
-rw-r--r--docs/user-guide.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/user-guide.md b/docs/user-guide.md
index 40af324..79cf511 100644
--- a/docs/user-guide.md
+++ b/docs/user-guide.md
@@ -97,6 +97,11 @@ performed.
platform name must be the name of one of the directories under the `plat/`
directory other than `common`.
+* `SHELL_COLOR`: Choose whether text messages should use shell's color escape
+ sequences to ease identifying which CPU displays it. If enabled, this makes
+ each CPU write part of the message in a different color. It can take either
+ 0 (disabled) or 1 (enabled) as values. 0 is the default.
+
* `TEST_REPORT_FORMAT`: Format of the test report. It can take either 'raw'
(text output on the console) or 'junit' (XML Junit format). The default is
'raw'.