aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLittleboy2011-04-28 05:02:39 -0400
committerLittleboy2011-04-28 05:02:39 -0400
commit5618276f1884788f44c0f43d7a287e800ba8b5e8 (patch)
tree370aee4761e5b9f5d91ed9a012eeba40ed0468ea
parent772864381856c2229129a38f6a12fc27dba286a0 (diff)
downloadscummvm-rg350-5618276f1884788f44c0f43d7a287e800ba8b5e8.tar.gz
scummvm-rg350-5618276f1884788f44c0f43d7a287e800ba8b5e8.tar.bz2
scummvm-rg350-5618276f1884788f44c0f43d7a287e800ba8b5e8.zip
TOOLS: Add documentation to create_project installer/revision build scripts
-rw-r--r--devtools/create_project/scripts/installer.vbs16
-rw-r--r--devtools/create_project/scripts/revision.vbs17
2 files changed, 31 insertions, 2 deletions
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