Add license header to Python files.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@2177 6f19259b-4bc3-4df7-8a09-765794883524

6 files changed, 76 insertions, 9 deletions

diff --git a/Tools/Python/Calc-Deps.py b/Tools/Python/Calc-Deps.py
index 204379a3cb..b022a907ae 100755
--- a/Tools/Python/Calc-Deps.py
+++ b/Tools/Python/Calc-Deps.py
@@ -1,5 +1,14 @@
 #!/usr/bin/env python
 
+# Copyright (c) 2007, Intel Corporation
+# All rights reserved. This program and the accompanying materials
+# are licensed and made available under the terms and conditions of the BSD License
+# which accompanies this distribution.  The full text of the license may be found at
+# http://opensource.org/licenses/bsd-license.php
+# 
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
 """Calculate the dependencies a given module has by looking through the source
 code to see what guids and functions are referenced to see which Packages and
 Library Classes need to be referenced. """
diff --git a/Tools/Python/ContextTool.py b/Tools/Python/ContextTool.py
index 3c95adb09d..0dfd5c65b4 100755
--- a/Tools/Python/ContextTool.py
+++ b/Tools/Python/ContextTool.py
@@ -1,6 +1,16 @@
 #!/usr/bin/env python
 
-# The EDK II Build System Context Tool Utility maintains Target.txt settings in an EDK II Workspace.
+# Copyright (c) 2007, Intel Corporation
+# All rights reserved. This program and the accompanying materials
+# are licensed and made available under the terms and conditions of the BSD License
+# which accompanies this distribution.  The full text of the license may be found at
+# http://opensource.org/licenses/bsd-license.php
+# 
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+"""The EDK II Build System Context Tool Utility maintains Target.txt settings
+in an EDK II Workspace."""
 
 import wx, os, sys, copy
 from EdkIIWorkspace import *
diff --git a/Tools/Python/Fd.py b/Tools/Python/Fd.py
index f71cc07171..f8b26059e7 100755
--- a/Tools/Python/Fd.py
+++ b/Tools/Python/Fd.py
@@ -1,7 +1,16 @@
 #!/usr/bin/env python
 
-# An EDK II Build System Framework Database Utility maintains FrameworkDatabase.db 
-#  settings in an EDK II Workspace.
+# Copyright (c) 2007, Intel Corporation
+# All rights reserved. This program and the accompanying materials
+# are licensed and made available under the terms and conditions of the BSD License
+# which accompanies this distribution.  The full text of the license may be found at
+# http://opensource.org/licenses/bsd-license.php
+# 
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+"""An EDK II Build System Framework Database Utility maintains
+FrameworkDatabase.db settings in an EDK II Workspace."""
 
 import wx, os, sys, copy
 from EdkIIWorkspace import *
@@ -570,4 +579,4 @@ if __name__ == '__main__':
   frame = Frame()
   frame.Show()
   app.MainLoop()
-  
\ No newline at end of file
+  
diff --git a/Tools/Python/MkFar.py b/Tools/Python/MkFar.py
index 327c81a94a..9c6cc5de55 100755
--- a/Tools/Python/MkFar.py
+++ b/Tools/Python/MkFar.py
@@ -1,5 +1,8 @@
 #!/usr/bin/env python
 
+"""This is a python script that takes user input from the command line and
+creates a far (Framework Archive Manifest) file for distribution."""
+
 import os, sys, getopt, string, xml.dom.minidom, zipfile, md5
 from XmlRoutines import *
 from WorkspaceRoutines import *
@@ -20,9 +23,13 @@ class Far:
     far.ExtraFiles=[]
 
 far = Far()
+"""The far object is constructed from the template file the user passed in."""
 
 def parseMsa(msaFile, spdDir):
 
+  """ XXX Parse an msa file and return a list of all the files that this msa
+  includes."""
+
   filelist = [msaFile]
 
   msaDir = os.path.dirname(msaFile)
@@ -41,6 +48,9 @@ def parseMsa(msaFile, spdDir):
 
 def parseSpd(spdFile):
 
+  """Parse an spd file and return a list of all the files that this spd
+  includes."""
+
   files = []
 
   spdDir = os.path.dirname(spdFile)
@@ -75,6 +85,9 @@ def parseSpd(spdFile):
 
 def makeFarHeader(doc):
 
+  """Create a dom tree for the Far Header. It will use information from the
+  template file passed on the command line, if present."""
+
   header = doc.createElement("FarHeader")
   name = doc.createElement("FarName")
   name.appendChild(doc.createTextNode(far.FarName))
@@ -105,6 +118,8 @@ def makeFarHeader(doc):
 
 def getSpdGuidVersion(spdFile):
 
+  """Returns a tuple (guid, version) which is read from the given spdFile."""
+
   spd = xml.dom.minidom.parse(inWorkspace(spdFile))
 
   return (XmlElement(spd, "/PackageSurfaceArea/SpdHeader/GuidValue"),
@@ -112,6 +127,8 @@ def getSpdGuidVersion(spdFile):
 
 def makeFar(files, farname):
 
+  """Make a far out of the given filelist and writes it to the file farname."""
+
   domImpl = xml.dom.minidom.getDOMImplementation()
   man = domImpl.createDocument(None, "FrameworkArchiveManifest", None)
   top_element = man.documentElement
@@ -197,6 +214,10 @@ def makeFar(files, farname):
   return
 
 def farFileNode(doc, filename):
+
+  """This is a function that returns a dom tree for a given file that is
+  included in the far. An md5sum is calculated for that file."""
+
   content = doc.createElement("FarFilename")
   f=open(filename, "rb")
   content.setAttribute("Md5sum", md5.md5(f.read()).hexdigest())
diff --git a/Tools/Python/WorkspaceRoutines.py b/Tools/Python/WorkspaceRoutines.py
index a34eff2d71..3634d25661 100755
--- a/Tools/Python/WorkspaceRoutines.py
+++ b/Tools/Python/WorkspaceRoutines.py
@@ -1,5 +1,14 @@
 #!/usr/bin/env python
 
+# Copyright (c) 2007, Intel Corporation
+# All rights reserved. This program and the accompanying materials
+# are licensed and made available under the terms and conditions of the BSD License
+# which accompanies this distribution.  The full text of the license may be found at
+# http://opensource.org/licenses/bsd-license.php
+# 
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
 import os, sys, re, getopt, string, glob, xml.dom.minidom, pprint, md5, socket, getpass, time, random
 
 def inWorkspace(rel_path=""):
diff --git a/Tools/Python/XmlRoutines.py b/Tools/Python/XmlRoutines.py
index 2707bcbb97..53f5aa8f61 100755
--- a/Tools/Python/XmlRoutines.py
+++ b/Tools/Python/XmlRoutines.py
@@ -1,7 +1,16 @@
 #!/usr/bin/env python
 
-# This is an XML API that uses a syntax similar to XPath, but it is written in
-# standard python so that no extra python packages are required to use it.
+# Copyright (c) 2007, Intel Corporation
+# All rights reserved. This program and the accompanying materials
+# are licensed and made available under the terms and conditions of the BSD License
+# which accompanies this distribution.  The full text of the license may be found at
+# http://opensource.org/licenses/bsd-license.php
+# 
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+"""This is an XML API that uses a syntax similar to XPath, but it is written in
+standard python so that no extra python packages are required to use it."""
 
 import xml.dom.minidom
 
@@ -35,10 +44,10 @@ def XmlElementData (Dom):
   """Get the text for this element."""
   return Dom.firstChild.data.strip()
 
-def XmlAttribute (Dom, String):
-  """Return a single attribute that named by String."""
+def XmlAttribute (Dom, AttName):
+  """Return a single attribute named AttName."""
   try:
-    return Dom.getAttribute(String)
+    return Dom.getAttribute(AttName)
   except:
     return ''