Annotate and the Log View
ARM DUI 0482K
Copyright © 2010-2012 ARM. All rights reserved.
10-3
ID120712
Non-Confidential
Unless you are running out of file handles, closing the annotate file on completion is optional.
Use the following basic annotate macros in your code:
ANNOTATE_SETUP()
Call this macro before any other annotate macros to setup annotation.
ANNOTATE_DEFINE()
Like
ANNOTATE_SETUP()
, you must insert a single instance of
ANNOTATE_DEFINE()
in
your code for annotation to work. Unlike
ANNOTATE_SETUP()
, it does not matter
where
ANNOTATE_DEFINE()
is called.
ANNOTATE(string)
This functions adds a string annotation. Because the
ANNOTATE
macro does not
define a specific channel, the annotation is added to channel 0 by default.
ANNOTATE_CHANNEL(channel, string)
Adds a string annotation to a channel defined by the numeric identifier passed to
the
channel
variable.
Note
Annotation channels and groups are used to organize annotations within the
threads shown in the processes section of the Timeline view. Each annotation
channel appears on its own line under the thread. Channels may also be sorted by
groups and displayed under a group name that you define using the
ANNOTATE_NAME_GROUP
macro.
ANNOTATE_COLOR(color, string)
Works the in the same way as the basic
ANNOTATE
macro, only use the
color
variable to define an interface display color for the annotation string.
ANNOTATE_CHANNEL_COLOR(channel, color, string)
Use this macro to define an annotation string, give it an color for display in the
interface, and assign it to a channel by passing a channel identifier to the
channel
variable.
ANNOTATE_END()
This command terminates the annotation.
ANNOTATE_CHANNEL_END(channel)
Terminates the annotation for the given channel.
ANNOTATE_NAME_CHANNEL(channel, group, string)
Use this command to name a channel and attach it to a group. Enter a number for
the
channel
variable, the identifier of a valid group for
group
, and your own
channel title for the
string
variable.
ANNOTATE_NAME_GROUP(group, string)
Use this command to give an annotation group a title. Pass a group identifier to
the
group
variable and a name for the group to the
string
variable.
