]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Ecc/config.ini
BaseTools/ECC: Fix an issue of parameter parser
[mirror_edk2.git] / BaseTools / Source / Python / Ecc / config.ini
CommitLineData
30fdf114
LG
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
1b2467c5 5# Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>\r
40d841f6 6# This program and the accompanying materials\r
30fdf114
LG
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
18Version = 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
e56468c0 24#\r
30fdf114
LG
25CheckAll = 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
39AutoCorrect = 1\r
40\r
41#\r
42# List customized Modifer here, split with ','\r
43#\r
72358997 44ModifierList = IN, OUT, OPTIONAL, UNALIGNED, EFI_RUNTIMESERVICE, EFI_BOOTSERVICE, EFIAPI, TPMINTERNALAPI, STATIC\r
30fdf114
LG
45\r
46#\r
47# General Checking\r
48#\r
49GeneralCheckAll = 0\r
50\r
51# Check whether NO Tab is used, replaced with spaces\r
52GeneralCheckNoTab = 1\r
53# The width of Tab\r
54GeneralCheckTabWidth = 2\r
55# Check whether the indentation is followed coding style\r
56GeneralCheckIndentation = 1\r
57# The width of indentation\r
58GeneralCheckIndentationWidth = 2\r
59# Check whether no line is exceeding defined widty\r
60GeneralCheckLine = 1\r
61# The width of a line\r
62GeneralCheckLineWidth = 120\r
63# Check whether no use of _asm in the source file\r
64GeneralCheckNo_Asm = 1\r
65# Check whether no use of "#progma" in source file except "#pragma pack(#)".\r
66GeneralCheckNoProgma = 1\r
67# Check whether there is a carriage return at the end of the file\r
68GeneralCheckCarriageReturn = 1\r
69# Check whether the file exists\r
70GeneralCheckFileExistence = 1\r
e56468c0 71# Check whether file has non ACSII char\r
72GeneralCheckNonAcsii = 1\r
b3d07ff8
HC
73# Check whether UNI file is valid\r
74GeneralCheckUni = 1\r
30fdf114
LG
75\r
76#\r
77# Space Checking\r
78#\r
79SpaceCheckAll = 1\r
80\r
81#\r
82# Predicate Expression Checking\r
83#\r
84PredicateExpressionCheckAll = 0\r
85\r
86# Check whether Boolean values, variable type BOOLEAN not use explicit comparisons to TRUE or FALSE\r
87PredicateExpressionCheckBooleanValue = 1\r
e56468c0 88# Check whether Non-Boolean comparisons use a compare operator (==, !=, >, < >=, <=).\r
30fdf114
LG
89PredicateExpressionCheckNonBooleanOperator = 1\r
90# Check whether a comparison of any pointer to zero must be done via the NULL type\r
91PredicateExpressionCheckComparisonNullType = 1\r
92\r
93#\r
94# Headers Checking\r
95#\r
96HeaderCheckAll = 0\r
97\r
98# Check whether File header exists\r
99HeaderCheckFile = 1\r
100# Check whether Function header exists\r
101HeaderCheckFunction = 1\r
d0acc87a
LG
102# Check whether Meta data File header Comment End with '##'\r
103HeaderCheckFileCommentEnd = 0\r
104# Check whether C File header Comment content start with two spaces\r
105HeaderCheckCFileCommentStartSpacesNum = 0\r
106# Check whether C File header Comment's each reference at list should begin with a bullet character '-'\r
107HeaderCheckCFileCommentReferenceFormat = 0\r
108# Check whether C File header Comment have the License immediately after the ""Copyright"" line\r
109HeaderCheckCFileCommentLicenseFormat = 0\r
30fdf114
LG
110\r
111#\r
112# C Function Layout Checking\r
113#\r
114CFunctionLayoutCheckAll = 0\r
115\r
116# Check whether return type exists and in the first line\r
117CFunctionLayoutCheckReturnType = 1\r
118# Check whether any optional functional modifiers exist and next to the return type\r
119CFunctionLayoutCheckOptionalFunctionalModifier = 1\r
120# Check whether the next line contains the function name, left justified, followed by the beginning of the parameter list\r
121# Check whether the closing parenthesis is on its own line and also indented two spaces\r
122CFunctionLayoutCheckFunctionName = 1\r
123# Check whether the function prototypes in include files have the same form as function definitions\r
124CFunctionLayoutCheckFunctionPrototype = 1\r
125# Check whether the body of a function is contained by open and close braces that must be in the first column\r
126CFunctionLayoutCheckFunctionBody = 1\r
127# Check whether the data declarations is the first code in a module.\r
128CFunctionLayoutCheckDataDeclaration = 1\r
129# Check whether no initialization of a variable as part of its declaration\r
130CFunctionLayoutCheckNoInitOfVariable = 1\r
131# Check whether no use of STATIC for functions\r
132CFunctionLayoutCheckNoStatic = 1\r
133\r
134#\r
135# Include Files Checking\r
136#\r
137IncludeFileCheckAll = 0\r
138\r
139#Check whether having include files with same name\r
140IncludeFileCheckSameName = 1\r
141# Check whether all include file contents is guarded by a #ifndef statement.\r
142# the #ifndef must be the first line of code following the file header comment\r
143# the #endif must appear on the last line in the file\r
144IncludeFileCheckIfndefStatement = 1\r
145# Check whether include files contain only public or only private data\r
146# Check whether include files NOT contain code or define data variables\r
147IncludeFileCheckData = 1\r
148\r
149#\r
150# Declarations and Data Types Checking\r
151#\r
152DeclarationDataTypeCheckAll = 0\r
153\r
154# Check whether no use of int, unsigned, char, void, static, long in any .c, .h or .asl files.\r
155DeclarationDataTypeCheckNoUseCType = 1\r
156# 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
157DeclarationDataTypeCheckInOutModifier = 1\r
158# Check whether the EFIAPI modifier should be used at the entry of drivers, events, and member functions of protocols\r
159DeclarationDataTypeCheckEFIAPIModifier = 1\r
160# Check whether Enumerated Type has a 'typedef' and the name is capital\r
161DeclarationDataTypeCheckEnumeratedType = 1\r
162# Check whether Structure Type has a 'typedef' and the name is capital\r
163DeclarationDataTypeCheckStructureDeclaration = 1\r
164# Check whether having same Structure\r
165DeclarationDataTypeCheckSameStructure = 1\r
166# Check whether Union Type has a 'typedef' and the name is capital\r
167DeclarationDataTypeCheckUnionType = 1\r
168\r
169\r
170#\r
171# Naming Conventions Checking\r
172#\r
173NamingConventionCheckAll = 0\r
174\r
175# Check whether only capital letters are used for #define declarations\r
176NamingConventionCheckDefineStatement = 1\r
177# Check whether only capital letters are used for typedef declarations\r
178NamingConventionCheckTypedefStatement = 1\r
179# Check whether the #ifndef at the start of an include file uses both prefix and postfix underscore characters, '_'.\r
180NamingConventionCheckIfndefStatement = 1\r
181# Rule for path name, variable name and function name\r
182# 1. First character should be upper case\r
183# 2. Existing lower case in a word\r
184# 3. No space existence\r
185# 4. Global variable name must start by a 'g'\r
186# Check whether the path name followed the rule\r
187NamingConventionCheckPathName = 1\r
188# Check whether the variable name followed the rule\r
189NamingConventionCheckVariableName = 1\r
190# Check whether the function name followed the rule\r
191NamingConventionCheckFunctionName = 1\r
192# Check whether NO use short variable name with single character\r
193NamingConventionCheckSingleCharacterVariable = 1\r
194\r
195#\r
196# Doxygen Checking\r
197#\r
198DoxygenCheckAll = 0\r
199\r
200# Check whether the file headers are followed Doxygen special documentation blocks in section 2.3.5\r
201DoxygenCheckFileHeader = 1\r
202# Check whether the function headers are followed Doxygen special documentation blocks in section 2.3.5\r
203DoxygenCheckFunctionHeader = 1\r
e56468c0 204# Check whether the first line of text in a comment block is a brief description of the element being documented.\r
30fdf114
LG
205# The brief description must end with a period.\r
206DoxygenCheckCommentDescription = 1\r
207# Check whether comment lines with '///< ... text ...' format, if it is used, it should be after the code section.\r
208DoxygenCheckCommentFormat = 1\r
209# Check whether only Doxygen commands allowed to mark the code are @bug and @todo.\r
210DoxygenCheckCommand = 1\r
211\r
212#\r
213# Meta-Data File Processing Checking\r
214#\r
215MetaDataFileCheckAll = 0\r
216\r
217# Check whether each file defined in meta-data exists\r
218MetaDataFileCheckPathName = 1\r
219# Generate a list for all files defined in meta-data files\r
220MetaDataFileCheckGenerateFileList = 1\r
221# The path of log file\r
222MetaDataFileCheckPathOfGenerateFileList = File.log\r
e56468c0 223# Check whether all Library Instances defined for a given module (or dependent library instance) match the module's type.\r
224# Each Library Instance must specify the Supported Module Types in its INF file,\r
30fdf114
LG
225# and any module specifying the library instance must be one of the supported types.\r
226MetaDataFileCheckLibraryInstance = 1\r
227# Check whether a Library Instance has been defined for all dependent library classes\r
228MetaDataFileCheckLibraryInstanceDependent = 1\r
229# Check whether the Library Instances specified by the LibraryClasses sections are listed in order of dependencies\r
230MetaDataFileCheckLibraryInstanceOrder = 1\r
231# Check whether the unnecessary inclusion of library classes in the INF file\r
232MetaDataFileCheckLibraryNoUse = 1\r
14239f66
HC
233# Check the header file in Include\Library directory whether be defined in the package DEC file.\r
234MetaDataFileCheckLibraryDefinedInDec = 1\r
30fdf114
LG
235# 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
236MetaDataFileCheckBinaryInfInFdf = 1\r
237# Not to report error and warning related OS include file such as "windows.h" and "stdio.h".\r
238# Check whether a PCD is set in a DSC file or the FDF file, but not in both.\r
239MetaDataFileCheckPcdDuplicate = 1\r
240# Check whether PCD settings in the FDF file can only be related to flash.\r
241MetaDataFileCheckPcdFlash = 1\r
242# Check whether PCDs used in INF files but not specified in DSC or FDF files\r
b3d07ff8 243MetaDataFileCheckPcdNoUse = 0\r
30fdf114
LG
244# Check whether having duplicate guids defined for Guid/Protocol/Ppi\r
245MetaDataFileCheckGuidDuplicate = 1\r
246# Check whether all files under module directory are described in INF files\r
247MetaDataFileCheckModuleFileNoUse = 1\r
248# Check whether the PCD is correctly used in C function via its type\r
249MetaDataFileCheckPcdType = 1\r
40d841f6
LG
250# Check whether there are FILE_GUID duplication among different INF files\r
251MetaDataFileCheckModuleFileGuidDuplication = 1\r
30fdf114 252\r
1b2467c5
HC
253#\r
254# Uni File Processing Checking\r
255#\r
256UniCheckAll = 0\r
257# Check INF or DEC file whether defined the localized information in the associated UNI file.\r
258UniCheckHelpInfo = 1\r
259# Check PCD whether defined the prompt, help in the DEC file and localized information in the associated UNI file.\r
260UniCheckPCDInfo = 1\r
b739e14d
HC
261# Uncheck whether UNI file is in UTF-16 format\r
262GeneralCheckUni = -1\r
1b2467c5 263\r
30fdf114
LG
264#\r
265# The check points in this section are reserved\r
266#\r
267# GotoStatementCheckAll = 0\r
268# SpellingCheckAll = 0\r
269#\r
e56468c0 270\r
271# A list for binary file ext name\r
272BinaryExtList = EXE, EFI, FV, ROM, DLL, COM, BMP, GIF, PYD, CMP, BIN, JPG, UNI, RAW, COM2, LIB, DEPEX, SYS, DB\r
e4ac870f
LG
273# A list for only scanning dirs, the dirs should be the top folder(s) under workspace\r
274ScanOnlyDirList = ScanFolder1 ScanFolder2\r