BaseTools/Source/Python/Ecc/config.ini

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