[mirror_edk2.git] / BaseTools / Source / Python / Ecc / config.ini

## @file\r
# This file is used to set configuration of ECC tool\r
# For the items listed below, 1 means valid, 0 means invalid\r
#\r
# Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
\r
#\r
# Identify the version of current configuration\r
#\r
Version = 0.1\r
\r
#\r
# Identify to if check all items\r
# 1 - Check all items and ignore all other detailed items\r
# 0 - Not check all items, the tool will go through all other detailed items to decide to check or not\r
#\r
CheckAll = 0\r
\r
#\r
# Identify to if automatically correct mistakes\r
# 1 - Automatically correct\r
# 0 - Not automatically correct\r
# Only the following check points can be automatically corrected, others not listed below are not supported even it is 1\r
#\r
# GeneralCheckTab\r
# GeneralCheckIndentation\r
# GeneralCheckLine\r
# GeneralCheckCarriageReturn\r
# SpaceCheckAll\r
#\r
AutoCorrect = 1\r
\r
#\r
# List customized Modifer here, split with ','\r
#\r
ModifierList = IN, OUT, OPTIONAL, UNALIGNED, EFI_RUNTIMESERVICE, EFI_BOOTSERVICE, EFIAPI, TPMINTERNALAPI\r
\r
#\r
# General Checking\r
#\r
GeneralCheckAll = 0\r
\r
# Check whether NO Tab is used, replaced with spaces\r
GeneralCheckNoTab = 1\r
# The width of Tab\r
GeneralCheckTabWidth = 2\r
# Check whether the indentation is followed coding style\r
GeneralCheckIndentation = 1\r
# The width of indentation\r
GeneralCheckIndentationWidth = 2\r
# Check whether no line is exceeding defined widty\r
GeneralCheckLine = 1\r
# The width of a line\r
GeneralCheckLineWidth = 120\r
# Check whether no use of _asm in the source file\r
GeneralCheckNo_Asm = 1\r
# Check whether no use of "#progma" in source file except "#pragma pack(#)".\r
GeneralCheckNoProgma = 1\r
# Check whether there is a carriage return at the end of the file\r
GeneralCheckCarriageReturn = 1\r
# Check whether the file exists\r
GeneralCheckFileExistence = 1\r
# Check whether file has non ACSII char\r
GeneralCheckNonAcsii = 1\r
\r
#\r
# Space Checking\r
#\r
SpaceCheckAll = 1\r
\r
#\r
# Predicate Expression Checking\r
#\r
PredicateExpressionCheckAll = 0\r
\r
# Check whether Boolean values, variable type BOOLEAN not use explicit comparisons to TRUE or FALSE\r
PredicateExpressionCheckBooleanValue = 1\r
# Check whether Non-Boolean comparisons use a compare operator (==, !=, >, < >=, <=).\r
PredicateExpressionCheckNonBooleanOperator = 1\r
# Check whether a comparison of any pointer to zero must be done via the NULL type\r
PredicateExpressionCheckComparisonNullType = 1\r
\r
#\r
# Headers Checking\r
#\r
HeaderCheckAll = 0\r
\r
# Check whether File header exists\r
HeaderCheckFile = 1\r
# Check whether Function header exists\r
HeaderCheckFunction = 1\r
\r
#\r
# C Function Layout Checking\r
#\r
CFunctionLayoutCheckAll = 0\r
\r
# Check whether return type exists and in the first line\r
CFunctionLayoutCheckReturnType = 1\r
# Check whether any optional functional modifiers exist and next to the return type\r
CFunctionLayoutCheckOptionalFunctionalModifier = 1\r
# Check whether the next line contains the function name, left justified, followed by the beginning of the parameter list\r
# Check whether the closing parenthesis is on its own line and also indented two spaces\r
CFunctionLayoutCheckFunctionName = 1\r
# Check whether the function prototypes in include files have the same form as function definitions\r
CFunctionLayoutCheckFunctionPrototype = 1\r
# Check whether the body of a function is contained by open and close braces that must be in the first column\r
CFunctionLayoutCheckFunctionBody = 1\r
# Check whether the data declarations is the first code in a module.\r
CFunctionLayoutCheckDataDeclaration = 1\r
# Check whether no initialization of a variable as part of its declaration\r
CFunctionLayoutCheckNoInitOfVariable = 1\r
# Check whether no use of STATIC for functions\r
CFunctionLayoutCheckNoStatic = 1\r
\r
#\r
# Include Files Checking\r
#\r
IncludeFileCheckAll = 0\r
\r
#Check whether having include files with same name\r
IncludeFileCheckSameName = 1\r
# Check whether all include file contents is guarded by a #ifndef statement.\r
# the #ifndef must be the first line of code following the file header comment\r
# the #endif must appear on the last line in the file\r
IncludeFileCheckIfndefStatement = 1\r
# Check whether include files contain only public or only private data\r
# Check whether include files NOT contain code or define data variables\r
IncludeFileCheckData = 1\r
\r
#\r
# Declarations and Data Types Checking\r
#\r
DeclarationDataTypeCheckAll = 0\r
\r
# Check whether no use of int, unsigned, char, void, static, long in any .c, .h or .asl files.\r
DeclarationDataTypeCheckNoUseCType = 1\r
# 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
DeclarationDataTypeCheckInOutModifier = 1\r
# Check whether the EFIAPI modifier should be used at the entry of drivers, events, and member functions of protocols\r
DeclarationDataTypeCheckEFIAPIModifier = 1\r
# Check whether Enumerated Type has a 'typedef' and the name is capital\r
DeclarationDataTypeCheckEnumeratedType = 1\r
# Check whether Structure Type has a 'typedef' and the name is capital\r
DeclarationDataTypeCheckStructureDeclaration = 1\r
# Check whether having same Structure\r
DeclarationDataTypeCheckSameStructure = 1\r
# Check whether Union Type has a 'typedef' and the name is capital\r
DeclarationDataTypeCheckUnionType = 1\r
\r
\r
#\r
# Naming Conventions Checking\r
#\r
NamingConventionCheckAll = 0\r
\r
# Check whether only capital letters are used for #define declarations\r
NamingConventionCheckDefineStatement = 1\r
# Check whether only capital letters are used for typedef declarations\r
NamingConventionCheckTypedefStatement = 1\r
# Check whether the #ifndef at the start of an include file uses both prefix and postfix underscore characters, '_'.\r
NamingConventionCheckIfndefStatement = 1\r
# Rule for path name, variable name and function name\r
# 1. First character should be upper case\r
# 2. Existing lower case in a word\r
# 3. No space existence\r
# 4. Global variable name must start by a 'g'\r
# Check whether the path name followed the rule\r
NamingConventionCheckPathName = 1\r
# Check whether the variable name followed the rule\r
NamingConventionCheckVariableName = 1\r
# Check whether the function name followed the rule\r
NamingConventionCheckFunctionName = 1\r
# Check whether NO use short variable name with single character\r
NamingConventionCheckSingleCharacterVariable = 1\r
\r
#\r
# Doxygen Checking\r
#\r
DoxygenCheckAll = 0\r
\r
# Check whether the file headers are followed Doxygen special documentation blocks in section 2.3.5\r
DoxygenCheckFileHeader = 1\r
# Check whether the function headers are followed Doxygen special documentation blocks in section 2.3.5\r
DoxygenCheckFunctionHeader = 1\r
# Check whether the first line of text in a comment block is a brief description of the element being documented.\r
# The brief description must end with a period.\r
DoxygenCheckCommentDescription = 1\r
# Check whether comment lines with '///< ... text ...' format, if it is used, it should be after the code section.\r
DoxygenCheckCommentFormat = 1\r
# Check whether only Doxygen commands allowed to mark the code are @bug and @todo.\r
DoxygenCheckCommand = 1\r
\r
#\r
# Meta-Data File Processing Checking\r
#\r
MetaDataFileCheckAll = 0\r
\r
# Check whether each file defined in meta-data exists\r
MetaDataFileCheckPathName = 1\r
# Generate a list for all files defined in meta-data files\r
MetaDataFileCheckGenerateFileList = 1\r
# The path of log file\r
MetaDataFileCheckPathOfGenerateFileList = File.log\r
# Check whether all Library Instances defined for a given module (or dependent library instance) match the module's type.\r
# Each Library Instance must specify the Supported Module Types in its INF file,\r
# and any module specifying the library instance must be one of the supported types.\r
MetaDataFileCheckLibraryInstance = 1\r
# Check whether a Library Instance has been defined for all dependent library classes\r
MetaDataFileCheckLibraryInstanceDependent = 1\r
# Check whether the Library Instances specified by the LibraryClasses sections are listed in order of dependencies\r
MetaDataFileCheckLibraryInstanceOrder = 1\r
# Check whether the unnecessary inclusion of library classes in the INF file\r
MetaDataFileCheckLibraryNoUse = 1\r
# 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
MetaDataFileCheckBinaryInfInFdf = 1\r
# Not to report error and warning related OS include file such as "windows.h" and "stdio.h".\r
# Check whether a PCD is set in a DSC file or the FDF file, but not in both.\r
MetaDataFileCheckPcdDuplicate = 1\r
# Check whether PCD settings in the FDF file can only be related to flash.\r
MetaDataFileCheckPcdFlash = 1\r
# Check whether PCDs used in INF files but not specified in DSC or FDF files\r
MetaDataFileCheckPcdNoUse = 1\r
# Check whether having duplicate guids defined for Guid/Protocol/Ppi\r
MetaDataFileCheckGuidDuplicate = 1\r
# Check whether all files under module directory are described in INF files\r
MetaDataFileCheckModuleFileNoUse = 1\r
# Check whether the PCD is correctly used in C function via its type\r
MetaDataFileCheckPcdType = 1\r
# Check whether there are FILE_GUID duplication among different INF files\r
MetaDataFileCheckModuleFileGuidDuplication = 1\r
\r
#\r
# The check points in this section are reserved\r
#\r
# GotoStatementCheckAll = 0\r
# SpellingCheckAll = 0\r
#\r
\r
# A list for binary file ext name\r
BinaryExtList = EXE, EFI, FV, ROM, DLL, COM, BMP, GIF, PYD, CMP, BIN, JPG, UNI, RAW, COM2, LIB, DEPEX, SYS, DB\r
Commit	Line	Data
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
40d841f6 LG	5	# Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
40d841f6 LG	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
	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
e56468c0	24	#\r
30fdf114 LG	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, TPMINTERNALAPI\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
e56468c0	71	# Check whether file has non ACSII char\r
e56468c0	72	GeneralCheckNonAcsii = 1\r
30fdf114 LG	73	\r
	74	#\r
	75	# Space Checking\r
	76	#\r
	77	SpaceCheckAll = 1\r
	78	\r
	79	#\r
	80	# Predicate Expression Checking\r
	81	#\r
	82	PredicateExpressionCheckAll = 0\r
	83	\r
	84	# Check whether Boolean values, variable type BOOLEAN not use explicit comparisons to TRUE or FALSE\r
	85	PredicateExpressionCheckBooleanValue = 1\r
e56468c0	86	# Check whether Non-Boolean comparisons use a compare operator (==, !=, >, < >=, <=).\r
30fdf114 LG	87	PredicateExpressionCheckNonBooleanOperator = 1\r
	88	# Check whether a comparison of any pointer to zero must be done via the NULL type\r
	89	PredicateExpressionCheckComparisonNullType = 1\r
	90	\r
	91	#\r
	92	# Headers Checking\r
	93	#\r
	94	HeaderCheckAll = 0\r
	95	\r
	96	# Check whether File header exists\r
	97	HeaderCheckFile = 1\r
	98	# Check whether Function header exists\r
	99	HeaderCheckFunction = 1\r
	100	\r
	101	#\r
	102	# C Function Layout Checking\r
	103	#\r
	104	CFunctionLayoutCheckAll = 0\r
	105	\r
	106	# Check whether return type exists and in the first line\r
	107	CFunctionLayoutCheckReturnType = 1\r
	108	# Check whether any optional functional modifiers exist and next to the return type\r
	109	CFunctionLayoutCheckOptionalFunctionalModifier = 1\r
	110	# Check whether the next line contains the function name, left justified, followed by the beginning of the parameter list\r
	111	# Check whether the closing parenthesis is on its own line and also indented two spaces\r
	112	CFunctionLayoutCheckFunctionName = 1\r
	113	# Check whether the function prototypes in include files have the same form as function definitions\r
	114	CFunctionLayoutCheckFunctionPrototype = 1\r
	115	# Check whether the body of a function is contained by open and close braces that must be in the first column\r
	116	CFunctionLayoutCheckFunctionBody = 1\r
	117	# Check whether the data declarations is the first code in a module.\r
	118	CFunctionLayoutCheckDataDeclaration = 1\r
	119	# Check whether no initialization of a variable as part of its declaration\r
	120	CFunctionLayoutCheckNoInitOfVariable = 1\r
	121	# Check whether no use of STATIC for functions\r
	122	CFunctionLayoutCheckNoStatic = 1\r
	123	\r
	124	#\r
	125	# Include Files Checking\r
	126	#\r
	127	IncludeFileCheckAll = 0\r
	128	\r
	129	#Check whether having include files with same name\r
	130	IncludeFileCheckSameName = 1\r
	131	# Check whether all include file contents is guarded by a #ifndef statement.\r
	132	# the #ifndef must be the first line of code following the file header comment\r
	133	# the #endif must appear on the last line in the file\r
	134	IncludeFileCheckIfndefStatement = 1\r
	135	# Check whether include files contain only public or only private data\r
	136	# Check whether include files NOT contain code or define data variables\r
	137	IncludeFileCheckData = 1\r
	138	\r
	139	#\r
	140	# Declarations and Data Types Checking\r
	141	#\r
	142	DeclarationDataTypeCheckAll = 0\r
	143	\r
	144	# Check whether no use of int, unsigned, char, void, static, long in any .c, .h or .asl files.\r
	145	DeclarationDataTypeCheckNoUseCType = 1\r
	146	# 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
	147	DeclarationDataTypeCheckInOutModifier = 1\r
	148	# Check whether the EFIAPI modifier should be used at the entry of drivers, events, and member functions of protocols\r
	149	DeclarationDataTypeCheckEFIAPIModifier = 1\r
	150	# Check whether Enumerated Type has a 'typedef' and the name is capital\r
151	DeclarationDataTypeCheckEnumeratedType = 1\r
152	# Check whether Structure Type has a 'typedef' and the name is capital\r
153	DeclarationDataTypeCheckStructureDeclaration = 1\r
154	# Check whether having same Structure\r
155	DeclarationDataTypeCheckSameStructure = 1\r
156	# Check whether Union Type has a 'typedef' and the name is capital\r
157	DeclarationDataTypeCheckUnionType = 1\r
158	\r
159	\r
160	#\r
161	# Naming Conventions Checking\r
162	#\r
163	NamingConventionCheckAll = 0\r
164	\r
165	# Check whether only capital letters are used for #define declarations\r
166	NamingConventionCheckDefineStatement = 1\r
167	# Check whether only capital letters are used for typedef declarations\r
168	NamingConventionCheckTypedefStatement = 1\r
169	# Check whether the #ifndef at the start of an include file uses both prefix and postfix underscore characters, '_'.\r
170	NamingConventionCheckIfndefStatement = 1\r
171	# Rule for path name, variable name and function name\r
172	# 1. First character should be upper case\r
173	# 2. Existing lower case in a word\r
174	# 3. No space existence\r
175	# 4. Global variable name must start by a 'g'\r
176	# Check whether the path name followed the rule\r
177	NamingConventionCheckPathName = 1\r
178	# Check whether the variable name followed the rule\r
179	NamingConventionCheckVariableName = 1\r
180	# Check whether the function name followed the rule\r
181	NamingConventionCheckFunctionName = 1\r
182	# Check whether NO use short variable name with single character\r
183	NamingConventionCheckSingleCharacterVariable = 1\r
184	\r
185	#\r
186	# Doxygen Checking\r
187	#\r
188	DoxygenCheckAll = 0\r
189	\r
190	# Check whether the file headers are followed Doxygen special documentation blocks in section 2.3.5\r
191	DoxygenCheckFileHeader = 1\r
192	# Check whether the function headers are followed Doxygen special documentation blocks in section 2.3.5\r
193	DoxygenCheckFunctionHeader = 1\r
e56468c0	194	# Check whether the first line of text in a comment block is a brief description of the element being documented.\r
30fdf114 LG	195	# The brief description must end with a period.\r
	196	DoxygenCheckCommentDescription = 1\r
	197	# Check whether comment lines with '///< ... text ...' format, if it is used, it should be after the code section.\r
	198	DoxygenCheckCommentFormat = 1\r
	199	# Check whether only Doxygen commands allowed to mark the code are @bug and @todo.\r
	200	DoxygenCheckCommand = 1\r
	201	\r
	202	#\r
	203	# Meta-Data File Processing Checking\r
	204	#\r
	205	MetaDataFileCheckAll = 0\r
	206	\r
	207	# Check whether each file defined in meta-data exists\r
	208	MetaDataFileCheckPathName = 1\r
	209	# Generate a list for all files defined in meta-data files\r
	210	MetaDataFileCheckGenerateFileList = 1\r
	211	# The path of log file\r
	212	MetaDataFileCheckPathOfGenerateFileList = File.log\r
e56468c0	213	# Check whether all Library Instances defined for a given module (or dependent library instance) match the module's type.\r
e56468c0	214	# Each Library Instance must specify the Supported Module Types in its INF file,\r
30fdf114 LG	215	# and any module specifying the library instance must be one of the supported types.\r
	216	MetaDataFileCheckLibraryInstance = 1\r
	217	# Check whether a Library Instance has been defined for all dependent library classes\r
	218	MetaDataFileCheckLibraryInstanceDependent = 1\r
	219	# Check whether the Library Instances specified by the LibraryClasses sections are listed in order of dependencies\r
	220	MetaDataFileCheckLibraryInstanceOrder = 1\r
	221	# Check whether the unnecessary inclusion of library classes in the INF file\r
	222	MetaDataFileCheckLibraryNoUse = 1\r
	223	# 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
	224	MetaDataFileCheckBinaryInfInFdf = 1\r
	225	# Not to report error and warning related OS include file such as "windows.h" and "stdio.h".\r
	226	# Check whether a PCD is set in a DSC file or the FDF file, but not in both.\r
	227	MetaDataFileCheckPcdDuplicate = 1\r
	228	# Check whether PCD settings in the FDF file can only be related to flash.\r
	229	MetaDataFileCheckPcdFlash = 1\r
	230	# Check whether PCDs used in INF files but not specified in DSC or FDF files\r
	231	MetaDataFileCheckPcdNoUse = 1\r
	232	# Check whether having duplicate guids defined for Guid/Protocol/Ppi\r
	233	MetaDataFileCheckGuidDuplicate = 1\r
	234	# Check whether all files under module directory are described in INF files\r
	235	MetaDataFileCheckModuleFileNoUse = 1\r
	236	# Check whether the PCD is correctly used in C function via its type\r
	237	MetaDataFileCheckPcdType = 1\r
40d841f6 LG	238	# Check whether there are FILE_GUID duplication among different INF files\r
40d841f6 LG	239	MetaDataFileCheckModuleFileGuidDuplication = 1\r
30fdf114 LG	240	\r
	241	#\r
	242	# The check points in this section are reserved\r
	243	#\r
	244	# GotoStatementCheckAll = 0\r
	245	# SpellingCheckAll = 0\r
	246	#\r
e56468c0	247	\r
	248	# A list for binary file ext name\r
	249	BinaryExtList = EXE, EFI, FV, ROM, DLL, COM, BMP, GIF, PYD, CMP, BIN, JPG, UNI, RAW, COM2, LIB, DEPEX, SYS, DB\r