sbsv2/raptor/notes/filter_html.txt
author Jon Chatten
Mon, 13 Sep 2010 14:04:04 +0100
changeset 641 8dd670a9f34f
parent 625 a1925fb7753a
permissions -rw-r--r--
sbs version 2.15.2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
625
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
     1
There is a new log filter to generate HTML output. For example,
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
     2
641
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
     3
sbs --filters=html -f name
625
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
     4
641
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
     5
will produce an output file "name_html/index.html" and other supporting files
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
     6
in the directory "name_html". This can be used alongside the Bz2 filter to
625
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
     7
generate both a human readable summary and a compressed log for further
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
     8
detailed machine analysis if required: for example,
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
     9
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    10
sbs --filters=html,bz2log -f name
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    11
641
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    12
will produce a folder "name_html" and a file "name.bz2".
625
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    13
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    14
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    15
If a build is done in several parts, for example,
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    16
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    17
sbs -s sys1.xml --filters=html,bz2log -f build/part1
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    18
sbs -s sys2.xml --filters=html,bz2log -f build/part2
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    19
sbs -s sys3.xml --filters=html,bz2log -f build/part3
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    20
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    21
Then there is a new script "SBS_HOME/bin/sbs_index.py" which can produce a
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    22
single index linking to all the individual parts: for example,
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    23
641
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    24
sbs_index.py build/part{1,2,3}_html build/index.html
625
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    25
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    26
the first parameters are the directories to search for summaries and the
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    27
last parameter is the name of the overall index file. Directories are
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    28
searched recursively, so the above example is the same as,
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    29
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    30
sbs_index.py build build/index.html
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    31
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    32
641
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    33
Text in the Raptor logs is classified as Error, Critical, Warning or Remark
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    34
using the list of regular expressions in the file,
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    35
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    36
SBS_HOME/lib/config/logfile_regex.csv
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    37
625
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    38
but this can be overriden by placing a file of the same name in the kit in
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    39
its EPOCROOT/epoc32/sbs_config folder.
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    40
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    41
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    42
The filter also checks that all the files which were listed in "what" output
a1925fb7753a sbs version 2.15.0
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff changeset
    43
actually exist at the end of the build. Any files which don't exist are
641
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    44
recorded as "Missing files".
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    45
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    46
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    47
Sometimes when a target cannot be built you will see errors like this in the
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    48
HTML report,
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    49
"
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    50
/opt/nokia/wk99/epoc32/build/something
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    51
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    52
required the following files which could not be found,
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    53
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    54
/opt/nokia/wk99/epoc32/include/foo
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    55
/opt/nokia/wk99/epoc32/include/bar
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    56
"
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    57
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    58
which means that a dependency was created on "foo" and "bar" but the build
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    59
did not contain any information anywhere on how to build those files. This
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    60
is often caused by someone just forgetting to add files to the asset.
8dd670a9f34f sbs version 2.15.2
Jon Chatten
parents: 625
diff changeset
    61