analyzetool/commandlineengine/src/helps.cpp
branchRCL_3
changeset 59 8ad140f3dd41
parent 49 7fdc9a71d314
equal deleted inserted replaced
49:7fdc9a71d314 59:8ad140f3dd41
    30 	cout<< " - ";
    30 	cout<< " - ";
    31 	cout<< ATOOL_DATE;
    31 	cout<< ATOOL_DATE;
    32 	cout<< "\n";
    32 	cout<< "\n";
    33 	cout<< "Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).\nAll rights reserved.\n\n";
    33 	cout<< "Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).\nAll rights reserved.\n\n";
    34 	cout<< "Usage:\n";
    34 	cout<< "Usage:\n";
    35 	cout<< "atool -tr [optional parameters] abld [abld parameters]\n";
    35 	cout<< "atool -e [optional parameters] abld [abld parameters]\n";
    36 	cout<< "      -lf [optional parameters] abld [abld parameters]\n";
    36 	cout<< "      -me [optional parameters] abld [abld parameters]\n";
       
    37 	cout<< "      -mi [optional parameters] [-f data-file] sbs [sbs parameters]\n";
    37 	cout<< "      -a data-file [output-file] [-s symbol-file] [-l#]\n";
    38 	cout<< "      -a data-file [output-file] [-s symbol-file] [-l#]\n";
    38 	cout<< "      -p data-file output-file\n";
    39 	cout<< "      -p data-file output-file\n";
    39 	cout<< "      -c\n";
    40 	cout<< "      -c\n";
    40 	cout<< "      -v\n";
    41 	cout<< "      -v\n";
    41 	cout<< "      -help\n";
    42 	cout<< "      -help\n";
    42 	cout<< "\n";
    43 	cout<< "\n";
    43 	cout<< "Mandatory parameter to choose:\n";
    44 	cout<< "Mandatory parameter to choose:\n";
    44 	cout<< " -tr             Build project for analysis using output to trace.\n";
    45 	cout<< " -e              Build project for analysis using external data gathering.\n";
    45 	cout<< " -lf             Build project for analysis using logging to file.\n";
    46 	cout<< " -me             Build project for analysis using monitored external\n";
       
    47 	cout<< "                 data gathering.\n";
       
    48 	cout<< " -mi             Build project for analysis using monitored internal\n";
       
    49 	cout<< "                 data gathering.\n";
    46 	cout<< " abld...         Use SBS v.1 build system with defined build command,\n";
    50 	cout<< " abld...         Use SBS v.1 build system with defined build command,\n";
    47 	cout<< "                 which includes supported platform and build type.\n";
    51 	cout<< "                 which includes supported platform and build type.\n";
    48 	cout<< " sbs...          Use SBS v.2 (Raptor) build system with defined sbs build\n";
    52 	cout<< " sbs...          Use SBS v.2 (Raptor) build system with defined sbs build\n";
    49 	cout<< "                 command, which includes supported platform and build type.\n";
    53 	cout<< "                 command, which includes supported platform and build type.\n";
    50 	cout<< " -a              Analyze report file.\n";
    54 	cout<< " -a              Analyze report file.\n";
    57 	cout<< "Optional parameters:\n";
    61 	cout<< "Optional parameters:\n";
    58 	cout<< " -acs size       Specifies the call stack size gathered when memory\n";
    62 	cout<< " -acs size       Specifies the call stack size gathered when memory\n";
    59 	cout<< "                 is allocated. Size can be between 0-256.\n";
    63 	cout<< "                 is allocated. Size can be between 0-256.\n";
    60 	cout<< " -fcs size       Specifies the call stack size gathered when memory is freed.\n";
    64 	cout<< " -fcs size       Specifies the call stack size gathered when memory is freed.\n";
    61 	cout<< "                 Size can be between 0-256.\n";
    65 	cout<< "                 Size can be between 0-256.\n";
    62 	cout<< " -f data file    Specifies the filename for logging to file.\n";
    66 	cout<< " -f data file    Specifies the filename for monitored internal data gathering\n";
    63 	cout<< "                 (50 chars max). Cannot contain path.\n";
    67 	cout<< "                 (50 chars max). Cannot contain path.\n";
    64 	cout<< " -fp file path   Specifies the path of log file.\n";
       
    65 	cout<< "                 (in format <driveLetter>:\\<dir1>\\<dir2>\\...\\<dirN>\\)\n";
       
    66 	cout<< " output-file     Specifies the results data file name.\n";
    68 	cout<< " output-file     Specifies the results data file name.\n";
    67 	cout<< " -l              Logging level of analyze report(0,1,2,3), default 3.\n";
    69 	cout<< " -l              Logging level of analyze report(0,1,2,3), default 3.\n";
    68 	cout<< " -s symbol-file  Specifies rom/rofs symbol file(s) to be used in analyze.\n";
    70 	cout<< " -s symbol-file  Specifies rom/rofs symbol file(s) to be used in analyze.\n";
    69 	cout<< "                 Multiple -s options can be given.\n";
    71 	cout<< "                 Multiple -s options can be given.\n";
    70 	cout<< " -nobuild        Instruments the project.\n";
    72 	cout<< " -nobuild        Instruments the project.\n";
   121 //80cout<< "12345678901234567890123456789012345678901234567890123456789012345678901234567890";
   123 //80cout<< "12345678901234567890123456789012345678901234567890123456789012345678901234567890";
   122 	cout<< endl;
   124 	cout<< endl;
   123 	cout<< "Building syntax examples:" << endl;
   125 	cout<< "Building syntax examples:" << endl;
   124 	cout<< "Cmd   Description" << endl;
   126 	cout<< "Cmd   Description" << endl;
   125 	
   127 	
   126 	cout<< "atool -tr abld build armv5 udeb" << endl;
   128 	cout<< "atool -e abld build armv5 udeb" << endl;
   127 	cout<< "      Hooks every component from bld.inf. Using output to trace," << endl;
   129 	cout<< "      Hooks every component from bld.inf. Using external data gathering," << endl;
   128 	cout<< "      udeb build type and armv5 platform." << endl;
   130 	cout<< "      udeb build type and armv5 platform." << endl;
   129 
   131 
   130 	cout<< "atool -lf -acs 5 sbs -c winscw_udeb" << endl;
   132 	cout<< "atool -mi -acs 5 sbs -c winscw_udeb" << endl;
   131 	cout<< "      Hooks every component from bld.inf. Using Symbian Build System v.2" << endl;
   133 	cout<< "      Hooks every component from bld.inf. Using Symbian Build System v.2" << endl;
   132 	cout<< "      Using loging to data file, call stack size of 5" << endl;
   134 	cout<< "      Using monitored internal data gathering, call stack size of 5" << endl;
   133 	cout<< "      in allocations, udeb build type and winscw platform." << endl;
   135 	cout<< "      in allocations, udeb build type and winscw platform." << endl;
   134 	
   136 	
   135 	cout<< "atool -tr abld build armv5 udeb foobar" << endl;
   137 	cout<< "atool -me abld build armv5 udeb foobar" << endl;
   136 	cout<< "      Hooks only foobar.mmp component from bld.inf. Using " << endl;
   138 	cout<< "      Hooks only foobar.mmp component from bld.inf. Using monitored" << endl;
   137 	cout<< "      output to trace, udeb build type and armv5 platform." << endl;
   139 	cout<< "      external data gathering, udeb build type and armv5 platform." << endl;
   138 	
   140 	
   139 	cout<< "atool -lf -acs 0 -fcs 0 abld build armv5.default udeb" << endl;
   141 	cout<< "atool -e -acs 0 -fcs 0 abld build armv5.default udeb" << endl;
   140 	cout<< "      Hooks every component from bld.inf. Using default binary variant," << endl;
   142 	cout<< "      Hooks every component from bld.inf. Using default binary variant," << endl;
   141 	cout<< "      output to trace, 0 sized callstacks in allocation(s)/free(s)," << endl;
   143 	cout<< "      external data gathering, 0 sized callstacks in allocation(s)/free(s)," << endl;
   142 	cout<< "      udeb build type and armv5 platform." << endl;
   144 	cout<< "      udeb build type and armv5 platform." << endl;
   143 	
   145 	
   144 	cout<< "atool -tr sbs -b bld.inf -c armv5_udeb" << endl;
   146 	cout<< "atool -e sbs -b bld.inf -c armv5_udeb" << endl;
   145 	cout<< "      Hooks every component from bld.inf. Using Symbian Build System v.2" << endl;
   147 	cout<< "      Hooks every component from bld.inf. Using Symbian Build System v.2" << endl;
   146 	cout<< "      , output to trace, udeb build type and armv5 platform." << endl;
   148 	cout<< "      , external data gathering, udeb build type and armv5 platform." << endl;
   147 	
   149 	
   148 	cout<< "atool -tr sbs -s system.xml --config=winscw_udeb" << endl;
   150 	cout<< "atool -me sbs -s system.xml --config=winscw_udeb" << endl;
   149 	cout<< "      Hooks every layer defined in system.xml system model. Using Symbian Build" << endl;
   151 	cout<< "      Hooks every layer defined in system.xml system model. Using Symbian Build" << endl;
   150 	cout<< "      System v.2, output to trace, udeb build type and winscw platform." << endl;
   152 	cout<< "      System v.2, external data gathering, udeb build type and winscw platform." << endl;
   151 
   153 
   152 	cout<< endl;
   154 	cout<< endl;
   153 	cout<< "Instrumenting syntax examples:" << endl;
   155 	cout<< "Instrumenting syntax examples:" << endl;
   154 	cout<< "Cmd   Description" << endl;
   156 	cout<< "Cmd   Description" << endl;
   155 	cout<< "atool -tr -nobuild abld build winscw udeb" << endl;
   157 	cout<< "atool -e -nobuild abld build winscw udeb" << endl;
   156 	cout<< "      Instruments every component from bld.inf. Using output to trace,"<<endl;
   158 	cout<< "      Instruments every component from bld.inf. Using external data gathering,"<<endl;
   157 	cout<< "      udeb build target and winscw platform." << endl;
   159 	cout<< "      udeb build target and winscw platform." << endl;
   158     cout<< "   After project is instrumented, it needs to compiled using same platform and" << endl;
   160     cout<< "   After project is instrumented, it needs to compiled using same platform and" << endl;
   159 	cout<< "   build type as given to instrumenting. Use -c parameter to remove changes." << endl;
   161 	cout<< "   build type as given to instrumenting. Use -c parameter to remove changes." << endl;
   160 
   162 
   161 	cout<< endl;
   163 	cout<< endl;