diff options
| author | Ken Raeburn <raeburn@mit.edu> | 2007-09-24 22:05:56 +0000 |
|---|---|---|
| committer | Ken Raeburn <raeburn@mit.edu> | 2007-09-24 22:05:56 +0000 |
| commit | 5386b775b2fbce68cbc846f7dac3ef495e72457a (patch) | |
| tree | 34e1350d51f8265d21fc69f47e293ea1dec1b8c1 /src/windows/build/bkw-automation.html | |
| parent | ecdd7622b03b8e3ffa1dce68e081fca9e9b0aa70 (diff) | |
| download | krb5-5386b775b2fbce68cbc846f7dac3ef495e72457a.tar.gz krb5-5386b775b2fbce68cbc846f7dac3ef495e72457a.tar.xz krb5-5386b775b2fbce68cbc846f7dac3ef495e72457a.zip | |
Set svn:eol-style on a bunch of text-looking files that didn't have it
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@19972 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'src/windows/build/bkw-automation.html')
| -rw-r--r-- | src/windows/build/bkw-automation.html | 712 |
1 files changed, 356 insertions, 356 deletions
diff --git a/src/windows/build/bkw-automation.html b/src/windows/build/bkw-automation.html index 637c9c9b8..5e21ba570 100644 --- a/src/windows/build/bkw-automation.html +++ b/src/windows/build/bkw-automation.html @@ -1,356 +1,356 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/TR/1999/REC-html401-19991224/loose.dtd">
-<!-- saved from url=(0066)https://confab.mit.edu/confluence/display/ISDA/lore-bkw-automation --><HTML><HEAD>
- <TITLE>lore-bkw-automation - Confluence</TITLE>
- <META http-equiv="Content-Type" content="text/html; charset=utf-8">
- <META http-equiv="Pragma" content="no-cache">
- <META http-equiv="Expires" content="-1">
- <LINK href="css/main-action.css" type="text/css" rel="stylesheet">
- <LINK href="css\main-action(1).css" type="text/css" rel="stylesheet">
- <META content="MSHTML 6.00.2900.3059" name="GENERATOR"></HEAD>
- <BODY>
- <DIV style="MARGIN-LEFT: 10px; MARGIN-RIGHT: 10px" align="left">
- <DIV class="wiki-content" style="MARGIN-TOP: 5px; MARGIN-BOTTOM: 5px" align="left">The
- Kerberos for Windows (KfW) build is automated. A script will fetch the
- sources from a repository and then build, sign and package all the KfW
- distribution components.
- </DIV>
- <DIV class="wiki-content" style="MARGIN-TOP: 5px; MARGIN-BOTTOM: 5px" align="left">This
- description consists of
- </DIV>
- <UL>
- <LI>
- <A href="#Environment">Setting up the build environment</A>
- <LI>
- <A href="#Running">Running the script</A>
- <LI>
- <A href="Details">Script internal details</A>
- <LI>
- <A href="#Remainingwork">Remaining work / bug list</A>
- <LI>
- <A href="#Troubleshooting">Troubleshooting</A>
- </LI>
- </UL>
- <H2>Setting Up the Build Environment</H2>
- <P>KfW is built on a Windows PC, in the default Windows shell (cmd.exe). These
- components must be installed:</P>
- <UL>
- <LI>
- Visual Studio 2003<BR>
- Versions of Visual Studio before or after 2003 are not supported.
- <LI>
- A recent release of the
- <SPAN class="nobr">
- <A href="http://www.microsoft.com/downloads/details.aspx?FamilyId=0BAF2B35-C656-4969-ACE8-E4C0C0716ADB&displaylang=en">
- Microsoft Platform SDK</A></SPAN>
-
- <LI>
- <SPAN class="nobr">
- <A title="Visit page outside Confluence" href="http://www.activestate.com" rel="nofollow">
- ActiveState Perl 5.8 or more recent</A></SPAN><BR>
- Build 631 is known to work.
- <LI>
- <SPAN class="nobr">
- <A title="Visit page outside Confluence" href="http://www.doxygen.org/" rel="nofollow">
- Doxygen</A></SPAN>
- <LI>
- sed, awk, cat, rm and find<BR>
- These can be obtained from the
- <SPAN class="nobr">
- <A title="Visit page outside Confluence" href="http://cygwin.com/" rel="nofollow">Cygwin
- distribution</A></SPAN>.
- <BR clear="all">
- <BR clear="all">
- find must be in C:\tools\cygwin\bin, so install Cygwin in C:\tools\cygwin.
- <BR>
- <BR>
- The cygwin awk is a link and the MS shell doesn't deal well with that. <TT>C</TT>
- opy <TT>c:\tools\cygwin\bin\gawk</TT> to <TT>c:\tools\cygwin\bin\awk</TT>.
- <LI>
- <SPAN class="nobr">
- <A title="Visit page outside Confluence" href="http://sourceforge.net/project/showfiles.php?group_id=105970"
- rel="nofollow">Wix</A></SPAN>
- <LI>
- <SPAN class="nobr">
- <A title="Visit page outside Confluence" href="http://nsis.sourceforge.net" rel="nofollow">
- NSIS</A></SPAN></LI></UL>
- <H3>Environment variables</H3>
- <P>
- All the components above must be in PATH. Installing ActivePerl puts perl in
- the PATH. Doxygen, Cygwin, hhc, wix and nsis need to be added.</P>
- <P>perl must be installed so that .pl files are automatically executed with perl.
- The ActivePerl installation will do this for you.</P>
- <P>In the INCLUDE path, the Microsoft Platform SDK must come before the Microsoft
- Visual C++ include files. Using a Platform SDK Build Environment window will
- set this up the right way. </P>
- <P>If you make your path modifications permanent via Control Panel / System /
- Advanced / Environment Variables: If you use a Platform SDK Build
- Environment window, it appears that you need to put your PATH components in the
- System PATH, not the User PATH.</P>
- <P>Visual Studio installs hhc in C:\Program Files\HTML Help Workshop.</P>
- <P>nmake must be in PATH. If you use a Platform SDK build environment window, it is
- already done for you.</P>
- <h2>Running the Script<A name="Running"></A></h2>
- <P>
- The build is a perl script controlled by command line switches and an XML
- configuration file. The config file is required. Settings in the config file
- can be overridden by optional command line switches. </P>
- <P>There are options for controlling most steps of the build process. The
- steps are</P>
- <UL>
- <LI>
- Verifying the environment
- <LI>
- Fetching the sources from repositories
- <LI>
- Building the sources
- <LI>
- Setting up the packaging environment
- <LI>
- Building the installers
- <LI>
- Building the rest of the components
- </LI>
- </UL>
- <P>The usage message shows the switches that control these steps:</P>
- <P><TT>C:\Projects\KfW>perl bkw.pl /?</TT><BR>
- <TT>Usage: bkw.pl [options] NMAKE-options</TT></P>
- <P><TT> Options are case insensitive. </TT>
- </P>
- <P><TT> Options:
- <BR>
- </TT><TT> /help /?
- usage information (what you now see).
- <BR>
- /config /f path Path to config file. Default is
- bkwconfig.xml.
- <BR>
- /src /s dir Source directory to use.
- Should contain
- <BR>
-
-
- pismere/athena. If cvstag or svntag is null,
- <BR>
-
-
- the directory should be prepopulated.
- <BR>
- /out /o dir Directory to be created
- where build results will go
- <BR>
- </TT><TT> /repository checkout | co \ What repository action to take.
- <BR>
- /r
- update | up \ Options are to checkout, update, export<BR>
- export
- | ex \ or take no action [skip]. <BR>
-
- skip<BR>
- /username /u name username used to access svn if checking out.
- <BR>
- /cvstag /c tag use -r <tag>
- <TAG>in cvs
-command <BR> /svnbranch /b tag use
-/branches/<tag><TAG> instead of /trunk.<BR> /svntag /t tag use
-/tags/<tag><TAG> instead of /trunk.<BR> /debug
-/d Do debug make instead of
-release make. <BR>
-/[no]make
-Control the make
-step. <BR>
-/clean Build
-clean target. <BR>
-/[no]package Control the packaging step. <BR>
-/[no]sign Control
-signing
-of executable files. <BR> /verbose
-/v Debug mode - verbose output. <BR> /logfile /l path Where to write output.
-Default is bkw.pl.log. <BR>
- /nolog Don't
- save output. </TT>
- </P>
- <P><TT> Other:
- <BR>
- NMAKE-options any options you want to pass to NMAKE, which
- can be:
- <BR>
-
- (note: /nologo is always used)<BR>
- NODEBUG=1</TT></P>
- <P><TT>NMAKE-options any options you want to pass to NMAKE, which can be:</TT><BR>
- <TT>(note: /nologo is always used)</TT><BR>
- <TT>[ nmake options follow ]</TT></P>
- <P><BR>
- Notes on the script steps:</P>
- <P><STRONG>Verifying the environment</STRONG>:
- <BR>
- The script tests for each program that it needs and warns if the program isn't
- found.</P>
- <P><STRONG>Fetching sources from repositories</STRONG>:
- <BR>
- If building from a source distribution kit, this section does not apply.</P>
- <P>CVSROOT and SVNURL must be specified in the configuration file.</P>
- <P>A source zip file can only be produced if checking out fresh sources from a
- repository. </P>
- <P>If checking out, the entire pismere directory will be deleted. A warning
- message requires that you confirm this action.</P>
- <P><STRONG>Building the sources:</STRONG><BR>
- /DEBUG controls whether a debug or release build is done. /CLEAN will
- build the CLEAN target.</P>
- <P><STRONG>Setting up the packaging environment :<BR>
- </STRONG>The pre-package steps gathers up build results and puts them in a <FONT face="Courier">
- staging</FONT> area.
- </P>
- <P>If /SIGN is specified, <FONT face="Courier">.exe</FONT>s, <FONT face="Courier">.dll</FONT>s
- and <FONT face="Courier">.cpl</FONT>s are signed. The signing command
- template is in the configuration file.</P>
- <P><STRONG>Building the installers:</STRONG><BR>
- The <FONT face="Courier">staging </FONT>area is copied into a fresh area for
- each of the installers. The installer results are copied back to the <FONT face="Courier">
- staging </FONT>area.</P>
- <P><STRONG>Building the rest of the components:</STRONG><BR>
- Zip files are built in temporary areas and copied to <FONT face="Courier">outdir</FONT>.
- The installers and assorted files are copied from <FONT face="Courier">staging</FONT>
- to <FONT face="Courier">outdir</FONT>. If /SIGN is specified, the
- installers will be signed.</P>
- <P> </P>
- <H2><A name="Details"></A>Script Internal Details</H2>
- <H3><A name="Copylists"></A>Copy Lists</H3>
- <P>CopyLists are used in many places. For example, files to be put into
- a .zip are copied to a fresh directory which is then zipped up. There is
- an optional Configuration section and a required Files section. </P>
- <P>The configuration section defines the roots of the from and to paths and can
- optionally define path substitutions.
- </P>
- <P>The to and from paths are forced by the script rather than being set in the
- config file. Comments in the copyfile xml indicate this.</P>
- <P>Lengthy copy lists can be kept in separate files and included with the Include
- directive. Example:</P>
- <P><TT><Include path="sdkfiles.xml" /></TT></P>
- <H3>Substitution tags</H3>
- <P>Filenames in copylists can contain variable 'tags' that are replaced before the
- file is copied. Some configuration files contain substitution tags which
- customize the configuration. The supported tags are</P>
- <P>
- <TABLE id="Table3" height="0" cellSpacing="1" cellPadding="1" border="1">
- <TR>
- <TD width="136">%VERSION_MAJOR%</TD>
- <TD height="21">KfW Version from pismere/athena/include/kerberos.ver.</TD>
- </TR>
- <TR>
- <TD width="136">%VERSION_MINOR%</TD>
- <TD height="9">KfW Version from pismere/athena/include/kerberos.ver.</TD>
- </TR>
- <TR>
- <TD width="136">%VERSION_PATCH%</TD>
- <TD height="17">KfW Version from pismere/athena/include/kerberos.ver.</TD>
- </TR>
- <TR>
- <TD width="136">%filestem%</TD>
- <TD height="17">Defined as kfw-%VERSION_MAJOR%-%VERSION_MINOR%-%VERSION_PATCH%.</TD>
- </TR>
- <TR>
- <TD width="136">%debug%</TD>
- <TD>'dbg.' Only substituted during a debug build. </TD>
- </TR>
- <TR>
- <TD width="136">%release%</TD>
- <TD>'rel.' Only substituted during a release build.
- </TD>
- </TR>
- <TR>
- <TD width="136">%bldtype%</TD>
- <TD>Always substituted, to 'dbg' or 'rel,' depending on the type of build.</TD>
- </TR>
- <TR>
- <TD width="136">%-DEBUG%</TD>
- <TD>'-DEBUG' during a debug build; otherwise empty.</TD>
- </TR>
- <TR>
- <TD width="136">%BUILDDIR%</TD>
- <TD>SRCDIR\pismere. Used in site-local installer configuration files.</TD>
- </TR>
- <TR>
- <TD width="136">%TARGETDIR%</TD>
- <TD>SRCDIR\pismere\staging. Used in site-local installer configuration files.</TD>
- </TR>
- <TR>
- <TD width="136">%CONFIGDIR-WIX%</TD>
- <TD>SRCDIR\pismere\staging\sample. Used in site-local installer configuration
- files.</TD>
- </TR>
- <TR>
- <TD width="136">%CONFIGDIR-NSI%</TD>
- <TD>SRCDIR\pismere\staging. Used in site-local installer configuration files.</TD>
- </TR>
- </TABLE>
- </P>
- <P>The overall build configuration specifies a debug or release build. Debug
- and release results are put in different places. Files whose location
- depend on the build type can use %bldtype% in their names. The script
- will substitute %bldtype% with either dbg or rel, depending on the build
- type. <STRONG></P>
- </DIV>
- <DIV style="MARGIN-LEFT: 10px; MARGIN-RIGHT: 10px" align="left">
- <H3>Example</H3>
- </STRONG>
- <P>Here is a copylist entry. Each segment of the file's path that comes
- from a different place is in a different color.</P>
- <P>Release build. Config file:
- </P>
- <P>
- <TABLE id="Table2" cellSpacing="1" cellPadding="1" border="0">
- <TR>
- <TD colSpan="4"><FONT face="courier"><BKW_Config></FONT></TD>
- </TR>
- <TR>
- <TD width="23"></TD>
- <TD colSpan="3"><FONT face="courier"><Config></FONT></TD>
- </TR>
- <TR>
- <TD width="23"></TD>
- <TD width="20"></TD>
- <TD><FONT face="courier"><src value ="<FONT color="#000099">C:\bkw"</FONT> /></FONT>
- </TD>
- </TR>
- </TABLE>
- </P>
- <P>Copylist comments:</P>
- <P><tt><!-- File from paths are relative to
- <src>\<FONT color="#ff00cc">pismere\athena</FONT> --> <BR><!-- File to paths are relative to <src>\<FONT color="#00ff00">
- pismere\staging</FONT>
- --> </tt>
- </P>
- <P>When the script processes this copylist, it will force the from and to paths as
- indicated.</P>
- <P>This line
- </P>
- <P><tt><File name="<FONT color="#00ffff">comerr32.dll</FONT>" from="<FONT color="#ff9933">..\target\bin\i386</FONT>\<FONT color="#ff0000">%bldtype%</FONT>\"
- to="\<FONT color="#9966ff">bin\i386</FONT>" /></tt></P>
- <P>will result in <FONT face="Courier"><FONT color="#000099">C:\bkw</FONT>\<FONT color="#ff00cc">pismere\athena</FONT>\<FONT color="#ff9933">..\target\bin\i386</FONT>\<FONT color="#ff0000">rel</FONT>\<FONT color="#00ffff">comerr32.dll</FONT></FONT></P>
- <P>being copied to <FONT face="Courier"><FONT color="#000099">C:\bkw</FONT>\<FONT color="#00ff00">pismere\staging</FONT>\<FONT color="#9966ff">bin\i386</FONT>\<FONT color="#00ffff">comerr32.dll</FONT></FONT>.</P>
- <P>Other possible attributes in a copylist entry:</P>
- <UL>
- <LI>
- <TT>notrequired</TT>
- <LI>
- <TT>newname="filename"</TT>
- </LI>
- </UL>
- <P>By default, copylist entries are required and the script will die if they aren't
- present. To ignore missing files, add <TT>notrequired</TT>.</P>
- <P>To rename the file, set the <TT>newname</TT> attribute.</P>
- <H2><FONT face="Verdana"><A name="Remainingwork"></A>Remaining Work / Bug List</FONT></H2>
- <P>Implement RETAIL, OFFICIAL, PRERELEASE, PRIVATE, SPECIAL.</P>
- <P>Figure out what MIT_ONLY, BUILD_KFW, DEBUG_SYMBOL should be.</P>
- <P>TARGET, APPVER.</P>
- <P>NODEBUG=1. Set if release build.</P>
- <H2><FONT face="Verdana"><A name="Troubleshooting"></A>Troubleshooting</FONT>
- </H2>
- <P><STRONG>Can't clean directory; can't delete file or directory</STRONG><BR>
- Make sure a file in the named directory isn't open in another application.</P>
- <P><STRONG>Can't find kerberos.ver</STRONG><BR>
- You skipped the repository step and are trying to build in an empty directory.</P>
- </DIV>
- </BODY>
-</HTML>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/TR/1999/REC-html401-19991224/loose.dtd"> +<!-- saved from url=(0066)https://confab.mit.edu/confluence/display/ISDA/lore-bkw-automation --><HTML><HEAD> + <TITLE>lore-bkw-automation - Confluence</TITLE> + <META http-equiv="Content-Type" content="text/html; charset=utf-8"> + <META http-equiv="Pragma" content="no-cache"> + <META http-equiv="Expires" content="-1"> + <LINK href="css/main-action.css" type="text/css" rel="stylesheet"> + <LINK href="css\main-action(1).css" type="text/css" rel="stylesheet"> + <META content="MSHTML 6.00.2900.3059" name="GENERATOR"></HEAD> + <BODY> + <DIV style="MARGIN-LEFT: 10px; MARGIN-RIGHT: 10px" align="left"> + <DIV class="wiki-content" style="MARGIN-TOP: 5px; MARGIN-BOTTOM: 5px" align="left">The + Kerberos for Windows (KfW) build is automated. A script will fetch the + sources from a repository and then build, sign and package all the KfW + distribution components. + </DIV> + <DIV class="wiki-content" style="MARGIN-TOP: 5px; MARGIN-BOTTOM: 5px" align="left">This + description consists of + </DIV> + <UL> + <LI> + <A href="#Environment">Setting up the build environment</A> + <LI> + <A href="#Running">Running the script</A> + <LI> + <A href="Details">Script internal details</A> + <LI> + <A href="#Remainingwork">Remaining work / bug list</A> + <LI> + <A href="#Troubleshooting">Troubleshooting</A> + </LI> + </UL> + <H2>Setting Up the Build Environment</H2> + <P>KfW is built on a Windows PC, in the default Windows shell (cmd.exe). These + components must be installed:</P> + <UL> + <LI> + Visual Studio 2003<BR> + Versions of Visual Studio before or after 2003 are not supported. + <LI> + A recent release of the + <SPAN class="nobr"> + <A href="http://www.microsoft.com/downloads/details.aspx?FamilyId=0BAF2B35-C656-4969-ACE8-E4C0C0716ADB&displaylang=en"> + Microsoft Platform SDK</A></SPAN> + + <LI> + <SPAN class="nobr"> + <A title="Visit page outside Confluence" href="http://www.activestate.com" rel="nofollow"> + ActiveState Perl 5.8 or more recent</A></SPAN><BR> + Build 631 is known to work. + <LI> + <SPAN class="nobr"> + <A title="Visit page outside Confluence" href="http://www.doxygen.org/" rel="nofollow"> + Doxygen</A></SPAN> + <LI> + sed, awk, cat, rm and find<BR> + These can be obtained from the + <SPAN class="nobr"> + <A title="Visit page outside Confluence" href="http://cygwin.com/" rel="nofollow">Cygwin + distribution</A></SPAN>. + <BR clear="all"> + <BR clear="all"> + find must be in C:\tools\cygwin\bin, so install Cygwin in C:\tools\cygwin. + <BR> + <BR> + The cygwin awk is a link and the MS shell doesn't deal well with that. <TT>C</TT> + opy <TT>c:\tools\cygwin\bin\gawk</TT> to <TT>c:\tools\cygwin\bin\awk</TT>. + <LI> + <SPAN class="nobr"> + <A title="Visit page outside Confluence" href="http://sourceforge.net/project/showfiles.php?group_id=105970" + rel="nofollow">Wix</A></SPAN> + <LI> + <SPAN class="nobr"> + <A title="Visit page outside Confluence" href="http://nsis.sourceforge.net" rel="nofollow"> + NSIS</A></SPAN></LI></UL> + <H3>Environment variables</H3> + <P> + All the components above must be in PATH. Installing ActivePerl puts perl in + the PATH. Doxygen, Cygwin, hhc, wix and nsis need to be added.</P> + <P>perl must be installed so that .pl files are automatically executed with perl. + The ActivePerl installation will do this for you.</P> + <P>In the INCLUDE path, the Microsoft Platform SDK must come before the Microsoft + Visual C++ include files. Using a Platform SDK Build Environment window will + set this up the right way. </P> + <P>If you make your path modifications permanent via Control Panel / System / + Advanced / Environment Variables: If you use a Platform SDK Build + Environment window, it appears that you need to put your PATH components in the + System PATH, not the User PATH.</P> + <P>Visual Studio installs hhc in C:\Program Files\HTML Help Workshop.</P> + <P>nmake must be in PATH. If you use a Platform SDK build environment window, it is + already done for you.</P> + <h2>Running the Script<A name="Running"></A></h2> + <P> + The build is a perl script controlled by command line switches and an XML + configuration file. The config file is required. Settings in the config file + can be overridden by optional command line switches. </P> + <P>There are options for controlling most steps of the build process. The + steps are</P> + <UL> + <LI> + Verifying the environment + <LI> + Fetching the sources from repositories + <LI> + Building the sources + <LI> + Setting up the packaging environment + <LI> + Building the installers + <LI> + Building the rest of the components + </LI> + </UL> + <P>The usage message shows the switches that control these steps:</P> + <P><TT>C:\Projects\KfW>perl bkw.pl /?</TT><BR> + <TT>Usage: bkw.pl [options] NMAKE-options</TT></P> + <P><TT> Options are case insensitive. </TT> + </P> + <P><TT> Options: + <BR> + </TT><TT> /help /? + usage information (what you now see). + <BR> + /config /f path Path to config file. Default is + bkwconfig.xml. + <BR> + /src /s dir Source directory to use. + Should contain + <BR> + + + pismere/athena. If cvstag or svntag is null, + <BR> + + + the directory should be prepopulated. + <BR> + /out /o dir Directory to be created + where build results will go + <BR> + </TT><TT> /repository checkout | co \ What repository action to take. + <BR> + /r + update | up \ Options are to checkout, update, export<BR> + export + | ex \ or take no action [skip]. <BR> + + skip<BR> + /username /u name username used to access svn if checking out. + <BR> + /cvstag /c tag use -r <tag> + <TAG>in cvs +command <BR> /svnbranch /b tag use +/branches/<tag><TAG> instead of /trunk.<BR> /svntag /t tag use +/tags/<tag><TAG> instead of /trunk.<BR> /debug +/d Do debug make instead of +release make. <BR> +/[no]make +Control the make +step. <BR> +/clean Build +clean target. <BR> +/[no]package Control the packaging step. <BR> +/[no]sign Control +signing +of executable files. <BR> /verbose +/v Debug mode - verbose output. <BR> /logfile /l path Where to write output. +Default is bkw.pl.log. <BR> + /nolog Don't + save output. </TT> + </P> + <P><TT> Other: + <BR> + NMAKE-options any options you want to pass to NMAKE, which + can be: + <BR> + + (note: /nologo is always used)<BR> + NODEBUG=1</TT></P> + <P><TT>NMAKE-options any options you want to pass to NMAKE, which can be:</TT><BR> + <TT>(note: /nologo is always used)</TT><BR> + <TT>[ nmake options follow ]</TT></P> + <P><BR> + Notes on the script steps:</P> + <P><STRONG>Verifying the environment</STRONG>: + <BR> + The script tests for each program that it needs and warns if the program isn't + found.</P> + <P><STRONG>Fetching sources from repositories</STRONG>: + <BR> + If building from a source distribution kit, this section does not apply.</P> + <P>CVSROOT and SVNURL must be specified in the configuration file.</P> + <P>A source zip file can only be produced if checking out fresh sources from a + repository. </P> + <P>If checking out, the entire pismere directory will be deleted. A warning + message requires that you confirm this action.</P> + <P><STRONG>Building the sources:</STRONG><BR> + /DEBUG controls whether a debug or release build is done. /CLEAN will + build the CLEAN target.</P> + <P><STRONG>Setting up the packaging environment :<BR> + </STRONG>The pre-package steps gathers up build results and puts them in a <FONT face="Courier"> + staging</FONT> area. + </P> + <P>If /SIGN is specified, <FONT face="Courier">.exe</FONT>s, <FONT face="Courier">.dll</FONT>s + and <FONT face="Courier">.cpl</FONT>s are signed. The signing command + template is in the configuration file.</P> + <P><STRONG>Building the installers:</STRONG><BR> + The <FONT face="Courier">staging </FONT>area is copied into a fresh area for + each of the installers. The installer results are copied back to the <FONT face="Courier"> + staging </FONT>area.</P> + <P><STRONG>Building the rest of the components:</STRONG><BR> + Zip files are built in temporary areas and copied to <FONT face="Courier">outdir</FONT>. + The installers and assorted files are copied from <FONT face="Courier">staging</FONT> + to <FONT face="Courier">outdir</FONT>. If /SIGN is specified, the + installers will be signed.</P> + <P> </P> + <H2><A name="Details"></A>Script Internal Details</H2> + <H3><A name="Copylists"></A>Copy Lists</H3> + <P>CopyLists are used in many places. For example, files to be put into + a .zip are copied to a fresh directory which is then zipped up. There is + an optional Configuration section and a required Files section. </P> + <P>The configuration section defines the roots of the from and to paths and can + optionally define path substitutions. + </P> + <P>The to and from paths are forced by the script rather than being set in the + config file. Comments in the copyfile xml indicate this.</P> + <P>Lengthy copy lists can be kept in separate files and included with the Include + directive. Example:</P> + <P><TT><Include path="sdkfiles.xml" /></TT></P> + <H3>Substitution tags</H3> + <P>Filenames in copylists can contain variable 'tags' that are replaced before the + file is copied. Some configuration files contain substitution tags which + customize the configuration. The supported tags are</P> + <P> + <TABLE id="Table3" height="0" cellSpacing="1" cellPadding="1" border="1"> + <TR> + <TD width="136">%VERSION_MAJOR%</TD> + <TD height="21">KfW Version from pismere/athena/include/kerberos.ver.</TD> + </TR> + <TR> + <TD width="136">%VERSION_MINOR%</TD> + <TD height="9">KfW Version from pismere/athena/include/kerberos.ver.</TD> + </TR> + <TR> + <TD width="136">%VERSION_PATCH%</TD> + <TD height="17">KfW Version from pismere/athena/include/kerberos.ver.</TD> + </TR> + <TR> + <TD width="136">%filestem%</TD> + <TD height="17">Defined as kfw-%VERSION_MAJOR%-%VERSION_MINOR%-%VERSION_PATCH%.</TD> + </TR> + <TR> + <TD width="136">%debug%</TD> + <TD>'dbg.' Only substituted during a debug build. </TD> + </TR> + <TR> + <TD width="136">%release%</TD> + <TD>'rel.' Only substituted during a release build. + </TD> + </TR> + <TR> + <TD width="136">%bldtype%</TD> + <TD>Always substituted, to 'dbg' or 'rel,' depending on the type of build.</TD> + </TR> + <TR> + <TD width="136">%-DEBUG%</TD> + <TD>'-DEBUG' during a debug build; otherwise empty.</TD> + </TR> + <TR> + <TD width="136">%BUILDDIR%</TD> + <TD>SRCDIR\pismere. Used in site-local installer configuration files.</TD> + </TR> + <TR> + <TD width="136">%TARGETDIR%</TD> + <TD>SRCDIR\pismere\staging. Used in site-local installer configuration files.</TD> + </TR> + <TR> + <TD width="136">%CONFIGDIR-WIX%</TD> + <TD>SRCDIR\pismere\staging\sample. Used in site-local installer configuration + files.</TD> + </TR> + <TR> + <TD width="136">%CONFIGDIR-NSI%</TD> + <TD>SRCDIR\pismere\staging. Used in site-local installer configuration files.</TD> + </TR> + </TABLE> + </P> + <P>The overall build configuration specifies a debug or release build. Debug + and release results are put in different places. Files whose location + depend on the build type can use %bldtype% in their names. The script + will substitute %bldtype% with either dbg or rel, depending on the build + type. <STRONG></P> + </DIV> + <DIV style="MARGIN-LEFT: 10px; MARGIN-RIGHT: 10px" align="left"> + <H3>Example</H3> + </STRONG> + <P>Here is a copylist entry. Each segment of the file's path that comes + from a different place is in a different color.</P> + <P>Release build. Config file: + </P> + <P> + <TABLE id="Table2" cellSpacing="1" cellPadding="1" border="0"> + <TR> + <TD colSpan="4"><FONT face="courier"><BKW_Config></FONT></TD> + </TR> + <TR> + <TD width="23"></TD> + <TD colSpan="3"><FONT face="courier"><Config></FONT></TD> + </TR> + <TR> + <TD width="23"></TD> + <TD width="20"></TD> + <TD><FONT face="courier"><src value ="<FONT color="#000099">C:\bkw"</FONT> /></FONT> + </TD> + </TR> + </TABLE> + </P> + <P>Copylist comments:</P> + <P><tt><!-- File from paths are relative to + <src>\<FONT color="#ff00cc">pismere\athena</FONT> --> <BR><!-- File to paths are relative to <src>\<FONT color="#00ff00"> + pismere\staging</FONT> + --> </tt> + </P> + <P>When the script processes this copylist, it will force the from and to paths as + indicated.</P> + <P>This line + </P> + <P><tt><File name="<FONT color="#00ffff">comerr32.dll</FONT>" from="<FONT color="#ff9933">..\target\bin\i386</FONT>\<FONT color="#ff0000">%bldtype%</FONT>\" + to="\<FONT color="#9966ff">bin\i386</FONT>" /></tt></P> + <P>will result in <FONT face="Courier"><FONT color="#000099">C:\bkw</FONT>\<FONT color="#ff00cc">pismere\athena</FONT>\<FONT color="#ff9933">..\target\bin\i386</FONT>\<FONT color="#ff0000">rel</FONT>\<FONT color="#00ffff">comerr32.dll</FONT></FONT></P> + <P>being copied to <FONT face="Courier"><FONT color="#000099">C:\bkw</FONT>\<FONT color="#00ff00">pismere\staging</FONT>\<FONT color="#9966ff">bin\i386</FONT>\<FONT color="#00ffff">comerr32.dll</FONT></FONT>.</P> + <P>Other possible attributes in a copylist entry:</P> + <UL> + <LI> + <TT>notrequired</TT> + <LI> + <TT>newname="filename"</TT> + </LI> + </UL> + <P>By default, copylist entries are required and the script will die if they aren't + present. To ignore missing files, add <TT>notrequired</TT>.</P> + <P>To rename the file, set the <TT>newname</TT> attribute.</P> + <H2><FONT face="Verdana"><A name="Remainingwork"></A>Remaining Work / Bug List</FONT></H2> + <P>Implement RETAIL, OFFICIAL, PRERELEASE, PRIVATE, SPECIAL.</P> + <P>Figure out what MIT_ONLY, BUILD_KFW, DEBUG_SYMBOL should be.</P> + <P>TARGET, APPVER.</P> + <P>NODEBUG=1. Set if release build.</P> + <H2><FONT face="Verdana"><A name="Troubleshooting"></A>Troubleshooting</FONT> + </H2> + <P><STRONG>Can't clean directory; can't delete file or directory</STRONG><BR> + Make sure a file in the named directory isn't open in another application.</P> + <P><STRONG>Can't find kerberos.ver</STRONG><BR> + You skipped the repository step and are trying to build in an empty directory.</P> + </DIV> + </BODY> +</HTML> |