Fixed spelling and grammar.
authorlhauch <lhauch@7335b38e-4728-0410-8992-fb3ffe349368>
Wed, 19 Mar 2008 17:17:44 +0000 (17:17 +0000)
committerlhauch <lhauch@7335b38e-4728-0410-8992-fb3ffe349368>
Wed, 19 Mar 2008 17:17:44 +0000 (17:17 +0000)
git-svn-id: https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools@1081 7335b38e-4728-0410-8992-fb3ffe349368

Source/Python/Ecc/Check.py
Source/Python/Ecc/Configuration.py
Source/Python/Ecc/Database.py
Source/Python/Ecc/Ecc.py
Source/Python/Ecc/EccToolError.py

index daff1dc..b556c04 100644 (file)
@@ -160,7 +160,7 @@ class Check(object):
     #\r
     def MetaDataFileCheckBinaryInfInFdf(self):\r
         if EccGlobalData.gConfig.MetaDataFileCheckBinaryInfInFdf == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
-            EdkLogger.quiet("Checking non-binary module defined in Fdf files ...")\r
+            EdkLogger.quiet("Checking for non-binary modules defined in FDF files ...")\r
             SqlCommand = """select A.ID, A.Value1 from Fdf as A\r
                          where A.Model = %s\r
                          and A.Enabled > -1\r
@@ -177,14 +177,14 @@ class Check(object):
                                 """ % (MODEL_EFI_SOURCE_FILE, FilePath)\r
                 NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
                 if NewRecordSet!= []:\r
-                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_BINARY_INF_IN_FDF, OtherMsg = "File %s defined in Fdf file but not in Dsc file should be a binary module" % (FilePath), BelongsToTable = 'Fdf', BelongsToItem = FdfID)\r
+                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_BINARY_INF_IN_FDF, OtherMsg = "File %s defined in FDF file and not in DSC file must be a binary module" % (FilePath), BelongsToTable = 'Fdf', BelongsToItem = FdfID)\r
 \r
     #\r
     # Check whether a PCD is set in a Dsc file or the FDF file, but not in both.\r
     #\r
     def MetaDataFileCheckPcdDuplicate(self):\r
         if EccGlobalData.gConfig.MetaDataFileCheckPcdDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
-            EdkLogger.quiet("Checking duplicate pcd defined in both Dsc and Fdf files ...")\r
+            EdkLogger.quiet("Checking for duplicate PCDs defined in both DSC and FDF files ...")\r
             SqlCommand = """\r
                          select A.ID, A.Value2, B.ID, B.Value2 from Dsc as A, Fdf as B \r
                          where A.Model >= %s and A.Model < %s \r
@@ -195,15 +195,15 @@ class Check(object):
                          """% (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
             RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
             for Record in RecordSet:\r
-                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, OtherMsg = "The pcd '%s' is defined in both Fdf file and Dsc file" % (Record[1]), BelongsToTable = 'Dsc', BelongsToItem = Record[0])\r
-                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, OtherMsg = "The pcd '%s' is defined in both Fdf file and Dsc file" % (Record[3]), BelongsToTable = 'Fdf', BelongsToItem = Record[2])\r
+                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, OtherMsg = "The PCD '%s' is defined in both FDF file and DSC file" % (Record[1]), BelongsToTable = 'Dsc', BelongsToItem = Record[0])\r
+                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, OtherMsg = "The PCD '%s' is defined in both FDF file and DSC file" % (Record[3]), BelongsToTable = 'Fdf', BelongsToItem = Record[2])\r
 \r
     #\r
     # Check whether PCD settings in the FDF file can only be related to flash.\r
     #\r
     def MetaDataFileCheckPcdFlash(self):\r
         if EccGlobalData.gConfig.MetaDataFileCheckPcdFlash == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
-            EdkLogger.quiet("Checking only Flash related Pcd is used in FDF ...")\r
+            EdkLogger.quiet("Checking only Flash related PCDs are used in FDF ...")\r
             SqlCommand = """\r
                          select ID, Value2, BelongsToFile from Fdf as A\r
                          where A.Model >= %s and Model < %s\r
@@ -212,14 +212,14 @@ class Check(object):
                          """% (MODEL_PCD, MODEL_META_DATA_HEADER)\r
             RecordSet = EccGlobalData.gDb.TblFdf.Exec(SqlCommand)\r
             for Record in RecordSet:\r
-                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_FLASH, OtherMsg = "The pcd '%s' defined in Fdf file is not related to Flash" % (Record[1]), BelongsToTable = 'Fdf', BelongsToItem = Record[0])\r
+                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_FLASH, OtherMsg = "The PCD '%s' defined in FDF file is not related to Flash" % (Record[1]), BelongsToTable = 'Fdf', BelongsToItem = Record[0])\r
         \r
     #\r
     # Check whether PCDs used in Inf files but not specified in Dsc or FDF files\r
     #\r
     def MetaDataFileCheckPcdNoUse(self):\r
         if EccGlobalData.gConfig.MetaDataFileCheckPcdNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
-            EdkLogger.quiet("Checking no use pcds ...")\r
+            EdkLogger.quiet("Checking for non-specified PCDs ...")\r
             SqlCommand = """\r
                          select ID, Value2, BelongsToFile from Inf as A \r
                          where A.Model >= %s and Model < %s\r
@@ -235,14 +235,14 @@ class Check(object):
                          """% (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
             for Record in RecordSet:\r
-                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_NO_USE, OtherMsg = "The pcd '%s' defined in Inf file is not referenced by any Dsc of Fdf files" % (Record[1]), BelongsToTable = 'Inf', BelongsToItem = Record[0])\r
+                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_NO_USE, OtherMsg = "The PCD '%s' defined in INF file is not specified in either DSC or FDF files" % (Record[1]), BelongsToTable = 'Inf', BelongsToItem = Record[0])\r
         \r
     #\r
     # Check whether having duplicate guids defined for Guid/Protocol/Ppi\r
     #\r
     def MetaDataFileCheckGuidDuplicate(self):\r
         if EccGlobalData.gConfig.MetaDataFileCheckGuidDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
-            EdkLogger.quiet("Checking duplicate guid/ppi/protocol ...")\r
+            EdkLogger.quiet("Checking for duplicate GUID/PPI/PROTOCOL ...")\r
             #\r
             # Check Guid\r
             #\r
@@ -285,7 +285,7 @@ class Check(object):
                      """ % (Table.Table, Table.Table, Model, Model)\r
         RecordSet = Table.Exec(SqlCommand)\r
         for Record in RecordSet:\r
-            EccGlobalData.gDb.TblReport.Insert(ErrorID, OtherMsg = "The %s name '%s' is defined more than one time" % (Name, Record[1]), BelongsToTable = Table.Table, BelongsToItem = Record[0])\r
+            EccGlobalData.gDb.TblReport.Insert(ErrorID, OtherMsg = "The %s name '%s' is defined more than one time" % (Name.upper(), Record[1]), BelongsToTable = Table.Table, BelongsToItem = Record[0])\r
 \r
     #\r
     # Check whether these is duplicate Guid/Ppi/Protocol value\r
@@ -307,7 +307,7 @@ class Check(object):
                      """ % (Table.Table, Table.Table, Model, Model)\r
         RecordSet = Table.Exec(SqlCommand)\r
         for Record in RecordSet:\r
-            EccGlobalData.gDb.TblReport.Insert(ErrorID, OtherMsg = "The %s value '%s' is used more than one time" % (Name, Record[1]), BelongsToTable = Table.Table, BelongsToItem = Record[0])\r
+            EccGlobalData.gDb.TblReport.Insert(ErrorID, OtherMsg = "The %s value '%s' is used more than one time" % (Name.upper(), Record[1]), BelongsToTable = Table.Table, BelongsToItem = Record[0])\r
 \r
 ##\r
 #\r
@@ -316,4 +316,5 @@ class Check(object):
 #\r
 if __name__ == '__main__':\r
     Check = Check()\r
-    Check.Check()
\ No newline at end of file
+    Check.Check()\r
+\r
index 52515cf..50e6dc6 100644 (file)
@@ -262,7 +262,7 @@ class Configuration(object):
             if Line != '':\r
                 List = GetSplitValueList(Line, TAB_EQUAL_SPLIT)\r
                 if List[0] not in self.__dict__:\r
-                    ErrorMsg = "Invalid configuration option '%s' is found" % List[0]\r
+                    ErrorMsg = "Invalid configuration option '%s' was found" % List[0]\r
                     EdkLogger.error("Ecc", EdkLogger.ECC_ERROR, ErrorMsg, File = Filepath, Line = LineNo)\r
                 if List[0] == 'ModifierList':\r
                     List[1] = GetSplitValueList(List[1], TAB_COMMA_SPLIT)\r
@@ -273,4 +273,4 @@ class Configuration(object):
     def ShowMe(self):\r
         print self.Filename\r
         for Key in self.__dict__.keys():\r
-            print Key, '=', self.__dict__[Key]
\ No newline at end of file
+            print Key, '=', self.__dict__[Key]\r
index 0e9f0d6..411a292 100644 (file)
@@ -207,7 +207,7 @@ class Database(object):
             PcdID = self.TblPcd.Insert(Pcd.CName, Pcd.TokenSpaceGuidCName, Pcd.Token, Pcd.DatumType, Pcd.Model, \\r
                                FileID, -1, Pcd.StartLine, Pcd.StartColumn, Pcd.EndLine, Pcd.EndColumn)\r
                 \r
-        EdkLogger.verbose("Insert information of file %s ... DONE!" % File.FullPath)\r
+        EdkLogger.verbose("Insert information from file %s ... DONE!" % File.FullPath)\r
 \r
     ## UpdateIdentifierBelongsToFunction\r
     #\r
@@ -340,4 +340,4 @@ if __name__ == '__main__':
     \r
     Db.Close()\r
     EdkLogger.verbose("End at " + time.strftime('%H:%M:%S', time.localtime()))\r
-    
\ No newline at end of file
+    \r
index e08a4f5..2f25515 100644 (file)
@@ -202,7 +202,7 @@ class Ecc(object):
         if Options.Target != None:\r
             EccGlobalData.gTarget = os.path.normpath(Options.Target)\r
         else:\r
-            EdkLogger.warn("Ecc", EdkLogger.ECC_ERROR, "The target source tree is not specified, use current WORKSPACE instead.!")\r
+            EdkLogger.warn("Ecc", EdkLogger.ECC_ERROR, "The target source tree was not specified, using current WORKSPACE instead!")\r
             EccGlobalData.gTarget = os.path.normpath(os.getenv("WORKSPACE"))\r
         if Options.keepdatabase != None:\r
             self.IsInit = False\r
index eeebcc5..c79e41d 100644 (file)
@@ -90,9 +90,9 @@ ERROR_SPELLING_CHECK_ALL = 11000
 \r
 gEccErrorMessage = {\r
     ERROR_GENERAL_CHECK_ALL : "",\r
-    ERROR_GENERAL_CHECK_NO_TAB : "'TAB' is not allowed in source code, please replace them with spaces",\r
-    ERROR_GENERAL_CHECK_INDENTATION : "Indentation is not followed coding style",\r
-    ERROR_GENERAL_CHECK_LINE : "The width of each line is not followed coding style",\r
+    ERROR_GENERAL_CHECK_NO_TAB : "'TAB' character is not allowed in source code, please replace each 'TAB' with two spaces",\r
+    ERROR_GENERAL_CHECK_INDENTATION : "Indentation does not follow coding style",\r
+    ERROR_GENERAL_CHECK_LINE : "The width of each line does not follow coding style",\r
     ERROR_GENERAL_CHECK_NO_ASM : "There should be no use of _asm in the source file",\r
     ERROR_GENERAL_CHECK_NO_PROGMA : """There should be no use of "#progma" in source file except "#pragma pack(#)\"""",\r
     ERROR_GENERAL_CHECK_CARRIAGE_RETURN : "There should be a carriage return at the end of the file",\r
@@ -112,7 +112,7 @@ gEccErrorMessage = {
     ERROR_C_FUNCTION_LAYOUT_CHECK_ALL : "",\r
     ERROR_C_FUNCTION_LAYOUT_CHECK_RETURN_TYPE : "Return type of a function should exist and in the first line",\r
     ERROR_C_FUNCTION_LAYOUT_CHECK_OPTIONAL_FUNCTIONAL_MODIFIER : "Any optional functional modifiers should exist and next to the return type",\r
-    ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME : """Function name should be left justified and followed by the beginning of the parameter list, and the closing parenthesis is on its own line and also indented two spaces""",\r
+    ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME : """Function name should be left justified, followed by the beginning of the parameter list, with the closing parenthesis on its own line, indented two spaces""",\r
     ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE : "Function prototypes in include files have the same form as function definitions",\r
     ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_BODY : "The body of a function should be contained by open and close braces that must be in the first column",\r
     ERROR_C_FUNCTION_LAYOUT_CHECK_DATA_DECLARATION : "The data declarations should be the first code in a module",\r
@@ -123,28 +123,28 @@ gEccErrorMessage = {
     ERROR_INCLUDE_FILE_CHECK_IFNDEF_STATEMENT_1 : "All include file contents should be guarded by a #ifndef statement.",\r
     ERROR_INCLUDE_FILE_CHECK_IFNDEF_STATEMENT_2 : "The #ifndef must be the first line of code following the file header comment",\r
     ERROR_INCLUDE_FILE_CHECK_IFNDEF_STATEMENT_3 : "The #endif must appear on the last line in the file",\r
-    ERROR_INCLUDE_FILE_CHECK_DATA : "Include files should contain only public or only private data but not contain code or define data variables",\r
+    ERROR_INCLUDE_FILE_CHECK_DATA : "Include files should contain only public or only private data and cannot contain code or define data variables",\r
     \r
     ERROR_DECLARATION_DATA_TYPE_CHECK_ALL : "",\r
     ERROR_DECLARATION_DATA_TYPE_CHECK_NO_USE_C_TYPE : "There should be no use of int, unsigned, char, void, static, long in any .c, .h or .asl files",\r
     ERROR_DECLARATION_DATA_TYPE_CHECK_IN_OUT_MODIFIER : """The modifiers IN, OUT, OPTIONAL, and UNALIGNED should be used only to qualify arguments to a function and should not appear in a data type declaration""",\r
     ERROR_DECLARATION_DATA_TYPE_CHECK_EFI_API_MODIFIER : "The EFIAPI modifier should be used at the entry of drivers, events, and member functions of protocols",\r
-    ERROR_DECLARATION_DATA_TYPE_CHECK_ENUMERATED_TYPE : "Enumerated Type should have a 'typedef' and the name is capital",\r
-    ERROR_DECLARATION_DATA_TYPE_CHECK_STRUCTURE_DECLARATION : "Structure Type should have a 'typedef' and the name is capital",\r
-    ERROR_DECLARATION_DATA_TYPE_CHECK_UNION_TYPE : "Union Type should have a 'typedef' and the name is capital",\r
+    ERROR_DECLARATION_DATA_TYPE_CHECK_ENUMERATED_TYPE : "Enumerated Type should have a 'typedef' and the name must be in capital letters",\r
+    ERROR_DECLARATION_DATA_TYPE_CHECK_STRUCTURE_DECLARATION : "Structure Type should have a 'typedef' and the name must be in capital letters",\r
+    ERROR_DECLARATION_DATA_TYPE_CHECK_UNION_TYPE : "Union Type should have a 'typedef' and the name must be in capital letters",\r
     \r
     ERROR_NAMING_CONVENTION_CHECK_ALL : "",\r
     ERROR_NAMING_CONVENTION_CHECK_DEFINE_STATEMENT : "Only capital letters are allowed to be used for #define declarations",\r
     ERROR_NAMING_CONVENTION_CHECK_TYPEDEF_STATEMENT : "Only capital letters are allowed to be used for typedef declarations",\r
     ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT : "The #ifndef at the start of an include file should use both prefix and postfix underscore characters, '_'",\r
-    ERROR_NAMING_CONVENTION_CHECK_PATH_NAME : """Path name is not followed by below rules: 1. First character should be upper case 2. Existing lower case in a word 3. No space existence""",\r
-    ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME : """Variable name is not followed by below rules: 1. First character should be upper case 2. Existing lower case in a word 3. No space existence""",\r
-    ERROR_NAMING_CONVENTION_CHECK_FUNCTION_NAME : """Function name is not followed by below rules: 1. First character should be upper case 2. Existing lower case in a word 3. No space existence""",\r
-    ERROR_NAMING_CONVENTION_CHECK_SINGLE_CHARACTER_VARIABLE : "There should be no use of short variable name with single character",\r
+    ERROR_NAMING_CONVENTION_CHECK_PATH_NAME : """Path name does not follow the rules: 1. First character should be upper case 2. Must contain lower case characters 3. No white space characters""",\r
+    ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME : """Variable name does not follow the rules: 1. First character should be upper case 2. Must contain lower case characters 3. No white space characters""",\r
+    ERROR_NAMING_CONVENTION_CHECK_FUNCTION_NAME : """Function name does not follow the rules: 1. First character should be upper case 2. Must contain lower case characters 3. No white space characters""",\r
+    ERROR_NAMING_CONVENTION_CHECK_SINGLE_CHARACTER_VARIABLE : "There should be no use of short (single character) variable names",\r
     \r
     ERROR_DOXYGEN_CHECK_ALL : "",\r
-    ERROR_DOXYGEN_CHECK_FILE_HEADER : "The file headers should be followed Doxygen special documentation blocks in section 2.3.5",\r
-    ERROR_DOXYGEN_CHECK_FUNCTION_HEADER : "The function headers should be followed Doxygen special documentation blocks in section 2.3.5",\r
+    ERROR_DOXYGEN_CHECK_FILE_HEADER : "The file headers should follow Doxygen special documentation blocks in section 2.3.5",\r
+    ERROR_DOXYGEN_CHECK_FUNCTION_HEADER : "The function headers should follow Doxygen special documentation blocks in section 2.3.5",\r
     ERROR_DOXYGEN_CHECK_COMMENT_DESCRIPTION : """The first line of text in a comment block should be a brief description of the element being documented and the brief description must end with a period.""",\r
     ERROR_DOXYGEN_CHECK_COMMENT_FORMAT : "For comment line with '///< ... text ...' format, if it is used, it should be after the code section",\r
     ERROR_DOXYGEN_CHECK_COMMAND : "Only Doxygen commands @bug and @todo are allowed to mark the code",\r
@@ -153,16 +153,16 @@ gEccErrorMessage = {
     ERROR_META_DATA_FILE_CHECK_PATH_NAME : "The file defined in meta-data does not exist",\r
     ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1 : "A library instances defined for a given module (or dependent library instance) doesn't match the module's type.", \r
     ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_2 : "A library instance must specify the Supported Module Types in its INF file",\r
-    ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_DEPENDENT : "A library instance should has been defined for all dependent library classes",\r
+    ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_DEPENDENT : "A library instance must be defined for all dependent library classes",\r
     ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_ORDER : "The library Instances specified by the LibraryClasses sections should be listed in order of dependencies",\r
     ERROR_META_DATA_FILE_CHECK_LIBRARY_NO_USE : "There should be no unnecessary inclusion of library classes in the INF file",\r
-    ERROR_META_DATA_FILE_CHECK_BINARY_INF_IN_FDF : "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
-    ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE : "Duplicate PCDs are found in both FDF and DSC",\r
+    ERROR_META_DATA_FILE_CHECK_BINARY_INF_IN_FDF : "An INF file is specified in the FDF file, but not in the DSC file, therefore the INF file must be for a Binary module only",\r
+    ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE : "Duplicate PCDs found in both FDF and DSC files",\r
     ERROR_META_DATA_FILE_CHECK_PCD_FLASH : "PCD settings in the FDF file should only be related to flash",\r
-    ERROR_META_DATA_FILE_CHECK_PCD_NO_USE : "There should be no PCDs which is used in INF files but not specified in DSC or FDF files",\r
-    ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID : "Duplicate guid found",\r
-    ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL : "Duplicate protocol found",\r
-    ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI : "Duplicate ppi found",\r
+    ERROR_META_DATA_FILE_CHECK_PCD_NO_USE : "There should be no PCDs declared in INF files that are not specified in in either a DSC or FDF file",\r
+    ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID : "Duplicate GUID found",\r
+    ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL : "Duplicate PROTOCOL found",\r
+    ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI : "Duplicate PPI found",\r
     \r
     ERROR_SPELLING_CHECK_ALL : "",\r
     }\r