From 5618276f1884788f44c0f43d7a287e800ba8b5e8 Mon Sep 17 00:00:00 2001
From: Littleboy
Date: Thu, 28 Apr 2011 05:02:39 -0400
Subject: TOOLS: Add documentation to create_project installer/revision build
 scripts

---
 devtools/create_project/scripts/installer.vbs | 16 +++++++++++++++-
 devtools/create_project/scripts/revision.vbs  | 17 ++++++++++++++++-
 2 files changed, 31 insertions(+), 2 deletions(-)

(limited to 'devtools')

diff --git a/devtools/create_project/scripts/installer.vbs b/devtools/create_project/scripts/installer.vbs
index 3348b692e5..716fa279a9 100644
--- a/devtools/create_project/scripts/installer.vbs
+++ b/devtools/create_project/scripts/installer.vbs
@@ -21,6 +21,20 @@
 '
 '/
 
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+' This script calls the makensis tool to generate a NSIS Windows installer for ScummVM
+'
+' It tries to read the NSIS installation folder from the registry and then calls the
+' command line script compiler to create the installer.
+'
+' This is called from the postbuild.cmd batch file
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+'================================================================
+' TODO: Reduce duplication with revision.vbs script 
+'       (ReadRegistryKey and ParseCommandLine are identical)
+'================================================================
+
 Option Explicit
 
 Dim FSO : Set FSO = CreateObject("Scripting.FileSystemObject")
@@ -167,4 +181,4 @@ Function ReadRegistryKey(shive, subkey, valuename, architecture)
 	Set Outparams = objReg.ExecMethod_("GetStringValue", Inparams,,objCtx)
 
 	ReadRegistryKey = Outparams.SValue
-End Function
\ No newline at end of file
+End Function
diff --git a/devtools/create_project/scripts/revision.vbs b/devtools/create_project/scripts/revision.vbs
index 9c29a88f2d..fb904856ec 100644
--- a/devtools/create_project/scripts/revision.vbs
+++ b/devtools/create_project/scripts/revision.vbs
@@ -23,6 +23,21 @@
 '
 '/
 
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+' This script tries to determine a revision number based on the current working tree
+' by trying revision control tools in the following order:
+'   - git (with hg-git detection)
+'   - mercurial
+'   - TortoiseSVN
+'   - SVN
+'
+' It then writes a new header file to be included during build, with the revision
+' information, the current branch, the revision control system (when not git) and
+' a flag when the tree is dirty.
+'
+' This is called from the prebuild.cmd batch file
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
 Option Explicit
 
 ' Working copy check priority:
@@ -216,7 +231,7 @@ Function DetermineGitVersion()
 	Wscript.StdErr.Write "   Git...           "
 	tool = "git"
 
-	' First check if we have both a .git & .svn folders (in case hg-git has been set up to have the git folder at the working copy level)
+	' First check if we have both a .git & .hg folders (in case hg-git has been set up to have the git folder at the working copy level)
 	If FSO.FolderExists(rootFolder & "/.git") And FSO.FolderExists(rootFolder & "/.hg") Then
 		Wscript.StdErr.WriteLine "Mercurial clone with git repository in tree!"
 		Exit Function
-- 
cgit v1.2.3