1. Adjust the structure of TableFile
[people/mcb30/basetools.git] / Source / Python / Ecc / config.ini
1 ## @file\r
2 # This file is used to set configuration of ECC tool\r
3 # For the items listed below, 1 means valid, 0 means invalid\r
4 #\r
5 # Copyright (c) 2007, Intel Corporation\r
6 # All rights reserved. This program and the accompanying materials\r
7 # are licensed and made available under the terms and conditions of the BSD License\r
8 # which accompanies this distribution.  The full text of the license may be found at\r
9 # http://opensource.org/licenses/bsd-license.php\r
10 #\r
11 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13 #\r
14 \r
15 #\r
16 # Identify the version of current configuration\r
17 #\r
18 Version = 0.1\r
19 \r
20 #\r
21 # Identify to if check all items\r
22 # 1 - Check all items and ignore all other detailed items\r
23 # 0 - Not check all items, the tool will go through all other detailed items to decide to check or not\r
24\r
25 CheckAll = 0\r
26 \r
27 #\r
28 # Identify to if automatically correct mistakes\r
29 # 1 - Automatically correct\r
30 # 0 - Not automatically correct\r
31 # Only the following check points can be automatically corrected, others not listed below are not supported even it is 1\r
32 #\r
33 # GeneralCheckTab\r
34 # GeneralCheckIndentation\r
35 # GeneralCheckLine\r
36 # GeneralCheckCarriageReturn\r
37 # SpaceCheckAll\r
38 #\r
39 AutoCorrect = 1\r
40 \r
41 #\r
42 # List customized Modifer here, split with ','\r
43 #\r
44 ModifierList = IN, OUT, OPTIONAL, UNALIGNED, EFI_RUNTIMESERVICE, EFI_BOOTSERVICE, EFIAPI\r
45 \r
46 #\r
47 # General Checking\r
48 #\r
49 GeneralCheckAll = 0\r
50 \r
51 # Check whether NO Tab is used, replaced with spaces\r
52 GeneralCheckNoTab = 1\r
53 # The width of Tab\r
54 GeneralCheckTabWidth = 2\r
55 # Check whether the indentation is followed coding style\r
56 GeneralCheckIndentation = 1\r
57 # The width of indentation\r
58 GeneralCheckIndentationWidth = 2\r
59 # Check whether no line is exceeding defined widty\r
60 GeneralCheckLine = 1\r
61 # The width of a line\r
62 GeneralCheckLineWidth = 120\r
63 # Check whether no use of _asm in the source file\r
64 GeneralCheckNo_Asm = 1\r
65 # Check whether no use of "#progma" in source file except "#pragma pack(#)".\r
66 GeneralCheckNoProgma = 1\r
67 # Check whether there is a carriage return at the end of the file\r
68 GeneralCheckCarriageReturn = 1\r
69 # Check whether the file exists\r
70 GeneralCheckFileExistence = 1\r
71 \r
72 #\r
73 # Space Checking\r
74 #\r
75 SpaceCheckAll = 1\r
76 \r
77 #\r
78 # Predicate Expression Checking\r
79 #\r
80 PredicateExpressionCheckAll = 0\r
81 \r
82 # Check whether Boolean values, variable type BOOLEAN not use explicit comparisons to TRUE or FALSE\r
83 PredicateExpressionCheckBooleanValue = 1\r
84 # Check whether Non-Boolean comparisons use a compare operator (==, !=, >, < >=, <=). \r
85 PredicateExpressionCheckNonBooleanOperator = 1\r
86 # Check whether a comparison of any pointer to zero must be done via the NULL type\r
87 PredicateExpressionCheckComparisonNullType = 1\r
88 \r
89 #\r
90 # Headers Checking\r
91 #\r
92 HeaderCheckAll = 0\r
93 \r
94 # Check whether File header exists\r
95 HeaderCheckFile = 1\r
96 # Check whether Function header exists\r
97 HeaderCheckFunction = 1\r
98 \r
99 #\r
100 # C Function Layout Checking\r
101 #\r
102 CFunctionLayoutCheckAll = 0\r
103 \r
104 # Check whether return type exists and in the first line\r
105 CFunctionLayoutCheckReturnType = 1\r
106 # Check whether any optional functional modifiers exist and next to the return type\r
107 CFunctionLayoutCheckOptionalFunctionalModifier = 1\r
108 # Check whether the next line contains the function name, left justified, followed by the beginning of the parameter list\r
109 # Check whether the closing parenthesis is on its own line and also indented two spaces\r
110 CFunctionLayoutCheckFunctionName = 1\r
111 # Check whether the function prototypes in include files have the same form as function definitions\r
112 CFunctionLayoutCheckFunctionPrototype = 1\r
113 # Check whether the body of a function is contained by open and close braces that must be in the first column\r
114 CFunctionLayoutCheckFunctionBody = 1\r
115 # Check whether the data declarations is the first code in a module.\r
116 CFunctionLayoutCheckDataDeclaration = 1\r
117 # Check whether no initialization of a variable as part of its declaration\r
118 CFunctionLayoutCheckNoInitOfVariable = 1\r
119 # Check whether no use of STATIC for functions\r
120 CFunctionLayoutCheckNoStatic = 1\r
121 \r
122 #\r
123 # Include Files Checking\r
124 #\r
125 IncludeFileCheckAll = 0\r
126 \r
127 # Check whether all include file contents is guarded by a #ifndef statement.\r
128 # the #ifndef must be the first line of code following the file header comment\r
129 # the #endif must appear on the last line in the file\r
130 IncludeFileCheckIfndefStatement = 1\r
131 # Check whether include files contain only public or only private data\r
132 # Check whether include files NOT contain code or define data variables\r
133 IncludeFileCheckData = 1\r
134 \r
135 #\r
136 # Declarations and Data Types Checking\r
137 #\r
138 DeclarationDataTypeCheckAll = 0\r
139 \r
140 # Check whether no use of int, unsigned, char, void, static, long in any .c, .h or .asl files.\r
141 DeclarationDataTypeCheckNoUseCType = 1\r
142 # Check whether the modifiers IN, OUT, OPTIONAL, and UNALIGNED are used only to qualify arguments to a function and should not appear in a data type declaration\r
143 DeclarationDataTypeCheckInOutModifier = 1\r
144 # Check whether the EFIAPI modifier should be used at the entry of drivers, events, and member functions of protocols\r
145 DeclarationDataTypeCheckEFIAPIModifier = 1\r
146 # Check whether Enumerated Type has a 'typedef' and the name is capital\r
147 DeclarationDataTypeCheckEnumeratedType = 1\r
148 # Check whether Structure Type has a 'typedef' and the name is capital\r
149 DeclarationDataTypeCheckStructureDeclaration = 1\r
150 # Check whether Union Type has a 'typedef' and the name is capital\r
151 DeclarationDataTypeCheckUnionType = 1\r
152 \r
153 \r
154 #\r
155 # Naming Conventions Checking\r
156 #\r
157 NamingConventionCheckAll = 0\r
158 \r
159 # Check whether only capital letters are used for #define declarations\r
160 NamingConventionCheckDefineStatement = 1\r
161 # Check whether only capital letters are used for typedef declarations\r
162 NamingConventionCheckTypedefStatement = 1\r
163 # Check whether the #ifndef at the start of an include file uses both prefix and postfix underscore characters, ¡®_¡¯.\r
164 NamingConventionCheckIfndefStatement = 1\r
165 # Rule for path name, variable name and function name\r
166 # 1. First character should be upper case\r
167 # 2. Existing lower case in a word\r
168 # 3. No space existence\r
169 # Check whether the path name followed the rule\r
170 NamingConventionCheckPathName = 1\r
171 # Check whether the variable name followed the rule\r
172 NamingConventionCheckVariableName = 1\r
173 # Check whether the function name followed the rule\r
174 NamingConventionCheckFunctionName = 1\r
175 # Check whether NO use short variable name with single character\r
176 NamingConventionCheckSingleCharacterVariable = 1\r
177 \r
178 #\r
179 # Doxygen Checking\r
180 #\r
181 DoxygenCheckAll = 0\r
182 \r
183 # Check whether the file headers are followed Doxygen special documentation blocks in section 2.3.5\r
184 DoxygenCheckFileHeader = 1\r
185 # Check whether the function headers are followed Doxygen special documentation blocks in section 2.3.5\r
186 DoxygenCheckFunctionHeader = 1\r
187 # Check whether the first line of text in a comment block is a brief description of the element being documented. \r
188 # The brief description must end with a period.\r
189 DoxygenCheckCommentDescription = 1\r
190 # Check whether comment lines with ¡®///< ¡­ text ¡­¡¯ format, if it is used, it should be after the code section.\r
191 DoxygenCheckCommentFormat = 1\r
192 # Check whether only Doxygen commands allowed to mark the code are @bug and @todo.\r
193 DoxygenCheckCommand = 1\r
194 \r
195 #\r
196 # Meta-Data File Processing Checking\r
197 #\r
198 MetaDataFileCheckAll = 0\r
199 \r
200 # Check whether each file defined in meta-data exists\r
201 MetaDataFileCheckPathName = 1\r
202 # Generate a list for all files defined in meta-data files\r
203 MetaDataFileCheckGenerateFileList = 1\r
204 # The path of log file\r
205 MetaDataFileCheckPathOfGenerateFileList = C:\File.log\r
206 # Check whether all Library Instances defined for a given module (or dependent library instance) match the module¡¯s type.  \r
207 # Each Library Instance must specify the Supported Module Types in its INF file, \r
208 # and any module specifying the library instance must be one of the supported types.\r
209 MetaDataFileCheckLibraryInstance = 1\r
210 # Check whether a Library Instance has been defined for all dependent library classes\r
211 MetaDataFileCheckLibraryInstanceDependent = 1\r
212 # Check whether the Library Instances specified by the LibraryClasses sections are listed in order of dependencies\r
213 MetaDataFileCheckLibraryInstanceOrder = 1\r
214 # Check whether the unnecessary inclusion of library classes in the INF file\r
215 MetaDataFileCheckLibraryNoUse = 1\r
216 # Check whether an INF file is specified in the FDF file, but not in the DSC file, then the INF file must be for a Binary module only\r
217 MetaDataFileCheckBinaryInfInFdf = 1\r
218 Not to report error and warning related OS include file such as ¡°windows.h¡± and ¡°stdio.h¡±.\r
219 # Check whether a PCD is set in a DSC file or the FDF file, but not in both.\r
220 MetaDataFileCheckPcdDuplicate = 1\r
221 # Check whether PCD settings in the FDF file can only be related to flash.\r
222 MetaDataFileCheckPcdFlash = 1\r
223 # Check whether PCDs used in INF files but not specified in DSC or FDF files\r
224 MetaDataFileCheckPcdNoUse = 1\r
225 \r
226 #\r
227 # The check points in this section are reserved\r
228 #\r
229 # GotoStatementCheckAll = 0\r
230 # SpellingCheckAll = 0\r
231 #\r