Windows: Update the README-NT file
authorJeffrey Altman <jaltman@secure-endpoints.com>
Thu, 30 Jul 2009 13:56:33 +0000 (09:56 -0400)
committerJeffrey Altman <jaltman@openafs.org>
Thu, 30 Jul 2009 14:26:14 +0000 (07:26 -0700)
Update the README-NT to be more up to date.
It still requires a lot of work.

Reviewed-on: http://gerrit.openafs.org/253
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>

README-NT

index 7402075..1f18664 100644 (file)
--- a/README-NT
+++ b/README-NT
@@ -13,7 +13,8 @@ As of the OpenAFS 1.3 release series, Windows platforms released
 prior to Windows 2000 are no longer supported. As of the OpenAFS 1.5
 series, the Windows 9x components are being removed from the source tree.
 
-***********   Windows 2000/XP/2003/Vista/2008 Build Process *************
+
+****** Windows 2000/XP/2003/Vista/2008/Win7/2008-R2 Build Process ******
 
 Building OpenAFS for Windows requires configuring a Windows
 development system by installing compilation tools and header files.
@@ -31,11 +32,13 @@ one of:
  * Windows 2003 R2 (32 or 64)
  * Windows Vista (32 or 64)
  * Windows 2008 (32 or 64)
+ * Windows 7 (32 or 64)
+ * Windows 2008 R2 (32 or 64)
 
 The build process is controlled by a nmake file that generates the 
 necessary binaries and binds them into an install package.
 
-The following steps describe how to configure Windows 2000/XP:
+The following steps describe how to configure the development environment:
 
    A. Obtain a copy of the OpenAFS Source Tree
    B. Install Compiler and Development tools.
@@ -62,22 +65,49 @@ versions are supported:
 
     Microsoft Visual Studio .NET 2005
       available via a MSDN subscription
-      (recommended - required for 64-bit builds)
+      (used for OpenAFS.org distribution)
 
-    Microsoft Visual Studio 2008 is not supported
+    Microsoft Visual Studio 2008
+      available via a MSDN subscription
 
-The following Microsoft SDK is required:
+One of the following Microsoft SDKs is required:
 
-    Microsoft Platform SDK for Windows Server 2003 SP1 or Vista or 2008
-      http://www.microsoft.com/msdownload/platformsdk/sdkupdate/downlevel.htm [IE required]
-      http://www.microsoft.com/msdownload/platformsdk/sdkupdate/XPSP2FULLInstall.htm
+    Microsoft Platform SDK for Windows Server 2003 SP1
+    Microsoft SDK for Windows 6.0/6.0a
+    Microsoft SDK for Windows 6.1
 
-The following Microsoft DDK is required:
+One of the following Microsoft DDK/WDK is required:
 
     Microsoft Windows Server 2003 SP1 DDK
       available via a MSDN subscription or via free CD
       http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx
 
+    Microsoft Windows Driver Kit 6.0
+    Microsoft Windows Driver Kit 6.1
+
+NOTE: Not all combinations of Visual Studio, SDK, and DDK/WDK are 
+known to work.  OpenAFS for Windows is packaged by Secure Endpoints Inc.
+using the following configurations:
+
+    32-bit Packages:
+        Built on Windows XP SP3
+        Visual Studio 2005
+        Windows [Platform] SDK 6.0
+        Windows DDK 6.0
+        Target: i386_w2k
+        APPVER: 5.0
+
+    64-bit Packages:
+        Built on Windows Vista 64-bit SP2
+        Visual Studio 2005
+        Windows [Platform] SDK 6.0
+        Windows DDK 6.0
+        Target: amd64_w2k
+        APPVER: 5.02
+
+These configurations are used because they are the last configurations 
+that still support building for Microsoft Windows 2000.
+
 The Microsoft HTML Help Workshop is required:
 
     http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
@@ -86,11 +116,24 @@ The Microsoft Internationalized Domain Names (IDN) Mitigation APIs 1.1 is requir
 
     http://www.microsoft.com/downloads/details.aspx?FamilyId=AD6158D7-DDBA-416A-9109-07607425A815&displaylang=en
 
+ActiveState Perl 5.10 is required for man-page generation
+
+    http://www.activestate.com/activeperl/
+
+Cygwin is required for Docbook to HTML and Docbook to HTMLHelp conversion
+
+    http://cygwin.com/setup.exe
+
+Doxygen is required for Developer Documentation generation
+
+    http://www.stack.nl/~dimitri/doxygen/
+
 The NSIS installer requires about 14 MB of storage. The following 
 version is supported:
 
-    Nullsoft Scriptable Installation System 2.30
-      http://nsis.sourceforge.net/home/
+    Nullsoft Scriptable Installation System 2.44
+      http://sourceforge.net/project/showfiles.php?group_id=22049&package_id=15374
+    (Be sure to use the strlen 8192 binaries)
 
 The WiX installer requires about 18 MB of storage.  The following 
 version is supported:
@@ -100,7 +143,8 @@ version is supported:
 
 The OpenAFS Source directory requires about 360 MB storage. The Source
 directory size includes additional space for files that will be
-generated during the build process.
+generated during the build process.   A full build of Free and Checked
+installers on 64-bit Windows will require up to 1GB of storage.
 
 
 STEP A. Obtain a copy of the Open AFS Source Tree.
@@ -109,13 +153,14 @@ Transfer OpenAFS source tree onto your hardrive.  The source can be
 downloaded from the OpenAFS web site:
        http://www.OpenAFS.org/release/snapindex.html.
 
-For this example, download source for version 1.5.51 using the
+For this example, download source for version 1.5.61 using the
 following URL:
-http://www.openafs.org/dl/openafs/1.5.51/openafs-1.5.51-src.tar
+http://www.openafs.org/dl/openafs/1.5.61/openafs-1.5.61-src.tar
+http://www.openafs.org/dl/openafs/1.5.61/openafs-1.5.61-doc.tar
 
 HINT: DailySnapShots are pre-release source trees and much more
 likely to have compilation errors. If this is your first attempt, do
-your build based on a release version of the source, e.g. 1.5.51. Once
+your build based on a release version of the source, e.g. 1.5.61. Once
 you have completed a build process successfully, you can experiment with
 other source trees.
 
@@ -123,35 +168,31 @@ You will need an unzip utility that can expand compressed tar files.
 For example "Pkzip for Windows" from Pkware will uncompress tar files.
 (http://www.pkware.com/)
 
-Expand the downloaded tar file (openafs-1.5.51-src.tar) into target
-directory (c:\OpenAFS), the unzip routine will expand the source into a
-subdirectory tree:
-    c:\OpenAFS\OpenAFS-1.5.51\src
+Expand the downloaded tar files into target directory (c:\OpenAFS), 
+the unzip routine will expand the source into a subdirectory tree:
+    c:\OpenAFS\OpenAFS-1.5.61\ 
 
-Copy the files 'NTMakefile' and 'ntbuild.bat' from 'src' to the OpenAFS 
-base directory (aka %AFSROOT%):
+Copy the files 'NTMakefile' and 'ntbuild.bat' from the 'src' 
+subdirectory to the OpenAFS base directory (aka %AFSROOT%):
 
   From a DOS command prompt window, enter the following copy commands:
 
-    cd c:\OpenAFS\OpenAFS-1.5.51
-    copy src\NTMakefile .
+    cd c:\OpenAFS\OpenAFS-1.5.61
     copy src\ntbuild.bat .
 
-
 The OpenAFS base directory should look something like the following:
 
-  c:\OpenAFS\OpenAFS-1.5.51\
+  c:\OpenAFS\OpenAFS-1.5.61\
     NTMakefile
     ntbuild.bat
     src
-         
+    doc
 
 STEP B. Install compiler and development tools.
 
 Install a copy of Microsoft Visual Studio .NET, Visual Studio .NET 2003, 
-or Visual Studio .NET 2005.  Visual Studio 2008 has not been sufficiently
-tested to be considered "supported".  The "Typical" install setting is 
-sufficient.
+or Visual Studio .NET 2005.  Visual Studio 2008 can be used to produce
+builds but the resulting binaries cannot be used on Windows 2000.
 
 (1) You can reduce the installation size by selecting "Custom" install
 and remove all but the following Options:
@@ -181,7 +222,7 @@ from:
 
 by using Internet Explorer 5.x or higher.  (Active X controls are required)
 
-The header files that are required from a Microsoft SDK/DDK are:
+The header files that are required from a Microsoft SDK/WDK are:
 
    npapi.h    (Windows 2000,XP,2003 builds)
    netcfgx.h  (NSIS Loopback Adapter installer - Windows 2000,XP,2003 builds)
@@ -202,8 +243,12 @@ These files come from the following Microsoft DDKs/SDKs:
 STEP D. Configure NTBUILD.BAT.
 
 The NTBUILD.BAT file copied to the OpenAFS base directory must be 
-customized for use on your development system.  The following variables
-must be defined to match your configuration:
+customized for use on your development system.  The provided NTBUILD.BAT
+was developed for use with Visual Studio 2003 and the Windows Server 2003
+Platform SDK.  It requires significant modification to construct a build
+environment for use with other tools.  
+
+The following variables must be defined to match your configuration:
 
   AFSVER_CL: Set to 1200 if using MS Visual C++ 6.0
              Set to 1300 if using MS Visual Studio .NET
@@ -223,6 +268,9 @@ must be defined to match your configuration:
 
   NTDDKDIR2: Set to the short name of the INC\CRT DDK directory
 
+  MSIDNNLS: Set the the name of the Microsoft IDN Mitigation APIs 1.1
+            directory
+
   AFSROOT: Set to the short name of the OpenAFS Base directory.  This
            cannot be set to a UNC path.
 
@@ -240,6 +288,9 @@ must be defined to match your configuration:
    
   CODESIGN_URL: Support URL Displayed to End Users
 
+  CODESIGN_CROSS_CERT: Path to Microsoft Cross Signing Certificate
+                       (if you have one)
+
 
 STEP E. Set version and installation options (optional)
 
@@ -249,7 +300,9 @@ from:
        http://grand.central.org/dl/cellservdb/CellServDB
 then copy it to %AFSROOT%\src\WINNT\install\NSIS and name it afsdcell.ini
 
-Edit file %AFSROOT%\src\config\NTMakefile.i386_w2k
+Edit file %AFSROOT%\src\config\NTMakefile.i386_w2k or NTMakefile.amd64_w2k
+as appropriate:
+
     AFSPRODUCT_VER_MAJOR - Version Major Number
     AFSPRODUCT_VER_MINOR - Version Minor Number
     AFSPRODUCT_VER_PATCH - Version Patch Number
@@ -264,16 +317,22 @@ see the following:
 
    AFSPRODUCT_VER_MAJOR=1
    AFSPRODUCT_VER_MINOR=5
-   AFSPRODUCT_VER_PATCH=5100
+   AFSPRODUCT_VER_PATCH=6100
    AFSPRODUCT_VER_BUILD=0
    CELLNAME_DEFAULT=openafs.org
    CELLSERVDB_INSTALL=CellServDB.GrandCentral
    CELLSERVDB_WEB=http://grand.central.org/dl/cellservdb/CellServDB
 
-During the Open AFS installation process the user will be presented
+During the OpenAFS installation process the user will be presented
 with two choices for the CellServDB: Local copy (CELLSERVDB_INSTALL) and
 one that can be downloaded from the web (CELLSERVDB_WEB).
 
+IMPORTANT: When building your own binaries, you must set the AFSPRODUCT_VER_BUILD
+value to a number greater than 1023.  All values 0 to 1023 are reserved for use
+by official OpenAFS.org releases.  A failure to do so will result in Windows 
+Crash Reports for your binaries being delivered to OpenAFS.org for analysis.
+
+
 STEP F. Begin the build
 
 (1) From Windows 2000/XP/2003 open up a DOS prompt window.
@@ -300,27 +359,28 @@ STEP F. Begin the build
 
     (c) Execute the NTBUILD.BAT file with the parameter "checked"
 
-(4) Clean the work area:
+(4) Build the complete Windows 2000/XP/2003 development environment.
 
-    nmake /f NTMakefile clean
-
-(5) Build the complete Windows 2000/XP/2003 development environment.
-
-    nmake /f NTMakefile install
+      nmake /f NTMakefile install
 
 While the build is running you will see many compile warnings. This
 behavior is normal; the build process is successful as long as the build
 process doesn't terminate with an error ("nmake.exe return code 0x2")
-and it displays 'Build Finished Successfully'.
+and it displays 'Build Finished Successfully'.  Note that although the 
+the build target is "install", it does not install OpenAFS.
+
+(5) Before rebuilding you must clean the work area:
+
+    nmake /f NTMakefile clean
 
 
-STEP G. Install NSIS 2.30 (optional).
+STEP G. Install NSIS 2.44 (optional).
 
-Download the Nullsoft Scriptable Installation System (NSIS) 2.30 from
+Download the Nullsoft Scriptable Installation System (NSIS) 2.44 from
 
     http://nsis.sourceforge.net/home/
 
-Run the nsis-2.30.exe installer and install to "C:\Program Files\NSIS".
+Run the nsis-2.33.exe installer and install to "C:\Program Files\NSIS".
 Then download the large strings build zip file and replace the installed 
 files with the versions from the zip file.  These versions increase 
 the maximum string length from 1024 characters to 8192 characters.