bcc8fc7a9cc0cb66c8bde50c71dbce5242618a98
[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 # General Checking\r
43 #\r
44 GeneralCheckAll = 0\r
45 \r
46 GeneralCheckTab = 1\r
47 GeneralCheckTabWidth = 2\r
48 GeneralCheckIndentation = 1\r
49 GeneralCheckIndentationWidth = 2\r
50 GeneralCheckLine = 1\r
51 GeneralCheckLineWidth = 120\r
52 GeneralCheckNo_Asm = 1\r
53 GeneralCheckNoProgma = 1\r
54 GeneralCheckCarriageReturn = 1\r
55 GeneralCheckPathName = 1\r
56 \r
57 #\r
58 # Space Checking\r
59 #\r
60 SpaceCheckAll = 1\r
61 \r
62 #\r
63 # Predicate Expression Checking\r
64 #\r
65 PredicateExpressionCheckAll = 0\r
66 \r
67 PredicateExpressionCheckBooleanValue = 1\r
68 PredicateExpressionCheckBooleanOperator = 1\r
69 PredicateExpressionCheckNullType = 1\r
70 \r
71 #\r
72 # Headers Checking\r
73 #\r
74 HeaderCheckAll = 0\r
75 \r
76 HeaderCheckFile = 1\r
77 HeaderCheckFunction = 1\r
78 \r
79 #\r
80 # C Function Layout Checking\r
81 #\r
82 CFunctionLayoutCheckAll = 0\r
83 \r
84 CFunctionLayoutCheckReturnType = 1\r
85 CFunctionLayoutCheckOptionalFunctionalModifier = 1\r
86 CFunctionLayoutCheckFunctionName = 1\r
87 CFunctionLayoutCheckFunctionPrototype = 1\r
88 CFunctionLayoutCheckFunctionBody = 1\r
89 CFunctionLayoutCheckDataDeclaration = 1\r
90 CFunctionLayoutCheckNoStatic = 1\r
91 \r
92 #\r
93 # Include Files Checking\r
94 #\r
95 IncludeFileCheckAll = 0\r
96 \r
97 IncludeFileCheckIfndefStatement = 1\r
98 IncludeFileCheckData = 1\r
99 \r
100 #\r
101 # Declarations and Data Types Checking\r
102 #\r
103 DeclarationDataTypeCheckAll = 0\r
104 \r
105 DeclarationDataTypeCheckNoUseCType = 1\r
106 DeclarationDataTypeCheckInOutModifier = 1\r
107 DeclarationDataTypeCheckEFIAPIModifier = 1\r
108 DeclarationDataTypeCheckEnumeratedType = 1\r
109 DeclarationDataTypeCheckStructureDeclaration = 1\r
110 \r
111 #\r
112 # Naming Conventions Checking\r
113 #\r
114 NamingConventionCheckAll = 0\r
115 \r
116 NamingConventionCheckDefineStatement = 1\r
117 NamingConventionCheckTypedefStatement = 1\r
118 NamingConventionCheckIfndefStatement = 1\r
119 NamingConventionCheckPathName = 1\r
120 NamingConventionCheckVariableName = 1\r
121 NamingConventionCheckFunctionName = 1\r
122 NamingConventionCheckSingleCharacterVariable = 1\r
123 \r
124 #\r
125 # Doxygen Checking\r
126 #\r
127 DoxygenCheckAll = 0\r
128 \r
129 DoxygenCheckFileHeader = 1\r
130 DoxygenCheckFunctionHeader = 1\r
131 DoxygenCheckCommentDescription = 1\r
132 DoxygenCheckCommentFormat = 1\r
133 DoxygenCheckCommand = 1\r
134 \r
135 #\r
136 # Meta-Data File Processing Checking\r
137 #\r
138 MetaDataFileCheckAll = 0\r
139 \r
140 MetaDataFileCheckPathName = 1\r
141 MetaDataFileCheckGenerateFileList = 1\r
142 MetaDataFileCheckPathOfGenerateFileList = C:\File.log\r
143 MetaDataFileCheckLibraryInstance = 1\r
144 MetaDataFileCheckBinaryInfInFdf = 1\r
145 MetaDataFileCheckPcd = 1\r
146 \r
147 #\r
148 # The check points in this section are reserved\r
149 #\r
150 # GotoStatementCheckAll = 0\r
151 # SpellingCheckAll = 0\r
152 #\r