sbsv2/raptor/notes/tcomsupport.txt
branchfix
changeset 514 92300322d8f8
parent 512 f270c42a56c4
child 516 cd8318d5fb3a
equal deleted inserted replaced
513:a9260a413076 514:92300322d8f8
     1 Raptor supports a new interface to the trace compiler that allows
     1 New Trace Compiler
     2 Raptor to specify the direcotry in which trace data should be written.
     2 -------------------
     3 This allows components to support a new convention for where trace files
       
     4 are stored.
       
     5 
     3 
     6 The new convention that prevents the clashes where building the same
     4 Raptor supports an updated version of the Trace Compiler which has
       
     5 an improved commandline interface that allows Raptor to specify the
       
     6 directory in which trace data should be written.  This allows MMPs to
       
     7 implement a new convention for where trace files are stored.
       
     8 
       
     9 The new convention prevents clashes where building the same
     7 source file for different MMPs would previously have resulted in two
    10 source file for different MMPs would previously have resulted in two
     8 build tasks trying to create the same trace file (header/dictionary).
    11 build tasks trying to create the same trace file (header/dictionary).
     9 This caused build slowdowns and also made the trace data inaccurate.
    12 This caused build slowdowns and also made the trace data inaccurate.
    10 
    13 
       
    14 The standard for this directory is that the last twwo elements of the
       
    15 path should be
       
    16 
       
    17    traces/traces_<targetname>_<ext>
       
    18 
       
    19 e.g.
       
    20 
       
    21    traces/traces_euser_dll
       
    22 
       
    23 The new trace compiler also creates "autogen" headers in a new location
       
    24 under epoc32/include/platform rather than epoc32/incude/internal.
       
    25 
       
    26 Trace Headers Directory can now also be in SYSTEMINCLUDEs
       
    27 ----------------------------------------------------------
       
    28 
       
    29 Some teams were having trouble getting qmake to generate MMPs with
       
    30 USERINCLUDEs set.  So they were specifying the trace header directory in
       
    31 their SYTEMINCLUDEs.  This change causes Raptor to look for the traces
       
    32 directory in bot SYSTEMINCLUDES and USERINCLUDES.
       
    33 
       
    34 
       
    35 Automatic Macro definition - OST_TRACE_COMPILER_IN_USE
       
    36 --------------------------------------------------------
       
    37 
       
    38 When Raptor notices that the trace compiler is required for an MMP (by
       
    39 looking for the traces/targetname_ext directory in the SYSTEMINCLUDES
       
    40 or USERINCLUDES) it causes the application to build with the
       
    41 OST_TRACE_COMPILER_IN_USE defined automatically
       
    42 
       
    43 
       
    44 Create Trace Directories During Makefile Parse
       
    45 -----------------------------------------------
       
    46 
       
    47 Some build engines consider it a "clash" when two jobs attempt to make the
       
    48 same directory.  This change causes some important trace output directories
       
    49 to be created during makefile parsing which removes the (small) possibilty
       
    50 that they would clash during the build part.
       
    51