1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE concept |
|
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
|
12 <concept id="GUID-1CCFBCD1-543F-5C53-A1E7-594591BB5905" xml:lang="en"><title>How |
|
13 to use CapImportCheck</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <p><codeph>CapImportCheck</codeph> is a command line tool that allows you |
|
15 to compare the capabilities of a binary file with the capabilities of the |
|
16 binaries that may import that specific file. </p> |
|
17 <p>To use <codeph>CapImportCheck</codeph>, you need to define the name and |
|
18 location of the ROM log file, and the Symbian Capability List (<filepath><EPOCROOT>\epoc32\include\e32capability.h</filepath>). </p> |
|
19 <p>You also need to define the location of a file containing dependency data |
|
20 for ROM log binaries. This data is generated as a text file by a tool called <codeph>ImportsAnalyser</codeph>, |
|
21 provided with <codeph>CapImportCheck</codeph> (see below). This data is used |
|
22 by <codeph>CapImportCheck</codeph> to determine which binaries may import |
|
23 a given binary.</p> |
|
24 <p>The results are presented in HTML format, but may also be printed to the |
|
25 standard output.</p> |
|
26 <section><title>Running ImportsAnalyser</title> <p><codeph>ImportsAnalyser</codeph> is |
|
27 used to generate a mapping between a binary file and the binaries which import |
|
28 it. This information is used by <codeph>CapImportCheck</codeph> to determine |
|
29 dependency relationships between binaries in the ROM log.</p> <p><b>Command |
|
30 line syntax</b> </p> <p>The command line syntax to be used when running <codeph>CapImportsAnalyser</codeph> is |
|
31 shown below. </p> <p><codeph>>ImportsAnalyser.pl –r myRom.log [–p pluginTable.pld] |
|
32 [–D DependencyDataFile.txt] </codeph> </p> <p><b>Arguments</b> </p> <p>The |
|
33 following arguments are used.</p> <table id="GUID-FCFDB3E7-4BE3-59D5-B1B8-593CE485F770"> |
|
34 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
35 <tbody> |
|
36 <row> |
|
37 <entry><p> <codeph>-r <rom_log_file></codeph> </p> </entry> |
|
38 <entry><p> The name and location of the ROM log file to be checked, in relation |
|
39 to the directory where the tool is run from, for example <filepath>.\input\rom.log</filepath>. |
|
40 This is mandatory.</p> </entry> |
|
41 </row> |
|
42 <row> |
|
43 <entry><p> <codeph>-p <plugin_table></codeph> </p> </entry> |
|
44 <entry><p>The name of the <filepath>.pld</filepath> file containing plug-in |
|
45 relationships. This may be found <filepath><EPOCROOT>\epoc32\tools\CapTools\data</filepath>. |
|
46 If no plug-in table is specified, no dynamic dependencies are generated.</p> </entry> |
|
47 </row> |
|
48 <row> |
|
49 <entry><p><codeph>-D <dependency_data_file></codeph> </p> </entry> |
|
50 <entry><p>Defines the location of the output file containing dependency data.</p> </entry> |
|
51 </row> |
|
52 <row> |
|
53 <entry><p><codeph>-h</codeph> </p> </entry> |
|
54 <entry><p>Displays help information (optional).</p> </entry> |
|
55 </row> |
|
56 </tbody> |
|
57 </tgroup> |
|
58 </table> <p><b>Example</b> </p> <p>An example of how to use the <codeph>ImportsAnalyser</codeph> tool |
|
59 is shown below:</p> <codeblock id="GUID-67B4385F-6292-5833-BF01-D6D92DF1E2FD" xml:space="preserve">>ImportsAnalyser.pl -r .\input\rom.log -p plugintable.pld -D .input\depsData.txt</codeblock> </section> |
|
60 <section><title>Running CapImportCheck</title> <p>Once the dependency data |
|
61 has been generated, you can run <codeph>CapImportCheck</codeph>. Along with |
|
62 the dependency data file, you also need to specify the name and location of |
|
63 the ROM log file and the Symbian Capability list.</p> <p>You may also specify |
|
64 a capability override file, listing capabilities to be used instead of the |
|
65 capabilities of binaries found in the ROM log. </p> <p><b>Command line syntax</b> </p> <p>The |
|
66 command line syntax to be used when running <codeph>CapImportCheck</codeph> is |
|
67 shown below. </p> <p><codeph>>CapImportCheck.pl -r <rom_log_file> -s <Symbian_capability_list> |
|
68 -D <dependency_data_file> [-o <override_file>] [-R <HTML_report>]</codeph> </p> <p>Mandatory |
|
69 arguments are <codeph>-r</codeph>, <codeph>-s</codeph> and <codeph>-D</codeph>.</p> <p><b>Arguments</b> </p> <p>The |
|
70 following arguments are used.</p> <table id="GUID-7A42DC75-B9B6-5FDC-BEF9-AB68B6C9CBB6"> |
|
71 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
72 <tbody> |
|
73 <row> |
|
74 <entry><p> <codeph>-r <rom_log_file></codeph> </p> </entry> |
|
75 <entry><p> The name and location of the ROM log file to be checked, in relation |
|
76 to the directory where the tool is run from, for example <filepath>.\input\rom.log</filepath>. |
|
77 This is mandatory.</p> </entry> |
|
78 </row> |
|
79 <row> |
|
80 <entry><p> <codeph>-s <Symbian_capability_list></codeph> </p> </entry> |
|
81 <entry><p>The name of the Symbian Capability List, listing all the capabilities |
|
82 available to search, and their corresponding values. This is a header file |
|
83 named <filepath>e32capability.h</filepath>, located within <filepath><EPOCROOT>\epoc32\include</filepath>. |
|
84 This flag is mandatory.</p> </entry> |
|
85 </row> |
|
86 <row> |
|
87 <entry><p><codeph>-D <dependency_data_file></codeph> </p> </entry> |
|
88 <entry><p>Defines the location of the dependency data.</p> </entry> |
|
89 </row> |
|
90 <row> |
|
91 <entry><p><codeph>-O <override_file></codeph> </p> </entry> |
|
92 <entry><p>Defines a text file containing a list of binaries and capabilities, |
|
93 to be used instead of the ones found in the ROM log. This is optional. </p> <p>The |
|
94 file may contain a list of modifications to the set of capabilities granted |
|
95 to specified binaries. Capabilities can be added, removed or assigned, using |
|
96 the following format:</p> <codeblock id="GUID-2DAF3E35-2A1A-562E-B8F2-851AA5C9FA13" xml:space="preserve"> |
|
97 agnmodel.dll +00000000 000000c0 |
|
98 agnmodel.dll -00000000 00808000 |
|
99 form.dll +00000000 0F80FFFF</codeblock> <p>where the first line specifies |
|
100 that <filepath>agnmodel.dll</filepath> should be granted <codeph>c0</codeph> capabilities |
|
101 in addition to any existing capabilities, and the second line specifies that |
|
102 it should have its <codeph>808000</codeph> capabilities revoked. The third |
|
103 line specifies that <filepath>form.dll</filepath> should have those exact |
|
104 capabilities regardless of its existing capabilities.</p> </entry> |
|
105 </row> |
|
106 <row> |
|
107 <entry><p><codeph>-R <HTML_report></codeph> </p> </entry> |
|
108 <entry><p>Defines the name of the HTML report to be generated in the working |
|
109 directory. If not specified, the default name is <filepath>CapImportCheckReport.html</filepath>. </p> </entry> |
|
110 </row> |
|
111 <row> |
|
112 <entry><p><codeph>-h</codeph> </p> </entry> |
|
113 <entry><p>Displays help information (optional).</p> </entry> |
|
114 </row> |
|
115 </tbody> |
|
116 </tgroup> |
|
117 </table> <p><b>Example</b> </p> <p>An example of how to use the <codeph>CapImportCheck</codeph> tool |
|
118 is shown below:</p> <codeblock id="GUID-4C707D85-3012-5097-8DB1-B521640CA3E0" xml:space="preserve">>CapImportCheck.pl -r .\input\rom.log -s e32capability.h -D .input\depsData.txt -R results.html</codeblock> </section> |
|
119 </conbody><related-links> |
|
120 <link href="GUID-7387B16E-1978-5997-ACCB-BEBFD2609C86.dita"><linktext>CapImportCheck |
|
121 report - file format</linktext></link> |
|
122 <link href="GUID-3C042957-E7C7-53EC-9397-E5650D2D61AA.dita"><linktext>CapSearch |
|
123 Guide</linktext></link> |
|
124 <link href="GUID-54E05FE1-1A71-5293-9FB5-E27D7DF2392B.dita"><linktext>CapCheck |
|
125 Guide</linktext></link> |
|
126 </related-links></concept> |
|