Revision: 17282
          http://sourceforge.net/p/edk2/code/17282
Author:   jyao1
Date:     2015-05-01 23:09:53 +0000 (Fri, 01 May 2015)
Log Message:
-----------
enhancement to tool to generate the comments along with offsets in the .h file.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: "Mudusuru, Giri P" <[email protected]>
Reviewed-by: "Yao, Jiewen" <[email protected]> 

Modified Paths:
--------------
    trunk/edk2/IntelFspPkg/Tools/GenCfgOpt.py

Modified: trunk/edk2/IntelFspPkg/Tools/GenCfgOpt.py
===================================================================
--- trunk/edk2/IntelFspPkg/Tools/GenCfgOpt.py   2015-05-01 01:05:00 UTC (rev 
17281)
+++ trunk/edk2/IntelFspPkg/Tools/GenCfgOpt.py   2015-05-01 23:09:53 UTC (rev 
17282)
@@ -774,9 +774,10 @@
         TxtFd.close()
         return 0
 
-    def CreateField (self, Item, Name, Length, Offset, Struct):
+    def CreateField (self, Item, Name, Length, Offset, Struct, Help):
         PosName    = 28
         PosComment = 30
+        HelpLine=''
 
         IsArray = False
         if Length in [1,2,4,8]:
@@ -810,8 +811,10 @@
             Space2 = PosComment - len(Name)
         else:
             Space2 = 1
+        if Help != '':
+            HelpLine="   %s \n" % Help
 
-        return "  %s%s%s;%s/* Offset 0x%04X */\n" % (Type, ' ' * Space1, Name, 
' ' * Space2, Offset)
+        return "/**Offset 0x%04X \n%s**/\n  %s%s%s;%s\n" % (Offset, HelpLine, 
Type, ' ' * Space1, Name, ' ' * Space2)
 
 
     def CreateHeaderFile (self, InputHeaderFile, IsInternal):
@@ -919,12 +922,12 @@
                         NextVisible = True
                         Name = "Reserved" + Region[0] + "pdSpace%d" % ResvIdx
                         ResvIdx = ResvIdx + 1
-                        HeaderFd.write(self.CreateField (Item, Name, 
Item["offset"] - ResvOffset, ResvOffset, ''))
+                        HeaderFd.write(self.CreateField (Item, Name, 
Item["offset"] - ResvOffset, ResvOffset, '', ''))
 
                 if  Offset < Item["offset"]:
                     if IsInternal or LastVisible:
                         Name = "Unused" + Region[0] + "pdSpace%d" % SpaceIdx
-                        LineBuffer.append(self.CreateField (Item, Name, 
Item["offset"] - Offset, Offset, ''))
+                        LineBuffer.append(self.CreateField (Item, Name, 
Item["offset"] - Offset, Offset, '',''))
                     SpaceIdx = SpaceIdx + 1
                     Offset   = Item["offset"]
 
@@ -940,7 +943,7 @@
                     for Each in LineBuffer:
                         HeaderFd.write (Each)
                     LineBuffer = []
-                    HeaderFd.write(self.CreateField (Item, Item["cname"], 
Item["length"], Item["offset"], Item['struct']))
+                    HeaderFd.write(self.CreateField (Item, Item["cname"], 
Item["length"], Item["offset"], Item['struct'], Item['help']))
 
             HeaderFd.write("} " + Region[0] + "PD_DATA_REGION;\n\n")
         HeaderFd.write("#pragma pack()\n\n")


------------------------------------------------------------------------------
One dashboard for servers and applications across Physical-Virtual-Cloud 
Widest out-of-the-box monitoring support with 50+ applications
Performance metrics, stats and reports that give you Actionable Insights
Deep dive visibility with transaction tracing using APM Insight.
http://ad.doubleclick.net/ddm/clk/290420510;117567292;y
_______________________________________________
edk2-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/edk2-commits

Reply via email to