DEVEL15-linux-allow-disabling-syscall-probing-20090602
[openafs.git] / README-NT
index 978e246..7402075 100644 (file)
--- a/README-NT
+++ b/README-NT
@@ -3,26 +3,17 @@ License.  For details, see the LICENSE file in the top-level source
 directory or on-line at http://www.openafs.org/dl/license10.html
 
 The document now provides a step by step procedure that takes the user 
-from a basic Windows 2000/XP/2003 workstation to an OpenAFS development 
-environment.   Details are provided so that a 'beginning' windows 
-developer can build an OpenAFS installable package for Windows 2000/XP/2003.
+from a basic Windows 2000/XP/2003/Vista/2008 workstation to an OpenAFS 
+development environment.   Details are provided so that a 'beginning' 
+windows developer can build an OpenAFS installable package for Windows 
+2000/XP/2003/Vista/2008.
 
 NOTE 1:
 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.
 
-NOTE 2:
-In this release, in addition to the production quality CIFS-AFS 
-gateway based client service there also exists an experimental
-implementation of an Installable File System (IFS).  To build the IFS 
-version, follow the directions below, but note that only the NSIS 
-installer script has been updated to support it.  Also, the IFS kernel 
-module must be built separately, using the IFS/DDK build environment.
-The IFS implementation does not contain a Network Provider interface
-to register an AFS service name.
-
-***********   Windows 2000/XP/2003 Build Process ****************
+***********   Windows 2000/XP/2003/Vista/2008 Build Process *************
 
 Building OpenAFS for Windows requires configuring a Windows
 development system by installing compilation tools and header files.
@@ -39,6 +30,7 @@ one of:
  * Windows 2003 64
  * Windows 2003 R2 (32 or 64)
  * Windows Vista (32 or 64)
+ * Windows 2008 (32 or 64)
 
 The build process is controlled by a nmake file that generates the 
 necessary binaries and binds them into an install package.
@@ -68,13 +60,15 @@ versions are supported:
     Microsoft Visual Studio .NET 2003
       available via a MSDN subscription
 
-    Microsoft Visual Studio .NET 2005 (required for AMD64 builds)
+    Microsoft Visual Studio .NET 2005
       available via a MSDN subscription
       (recommended - required for 64-bit builds)
 
+    Microsoft Visual Studio 2008 is not supported
+
 The following Microsoft SDK is required:
 
-    Microsoft Platform SDK for Windows XP SP2 or Server 2003 SP1 or Vista
+    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
 
@@ -88,6 +82,10 @@ The Microsoft HTML Help Workshop is required:
 
     http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
 
+The Microsoft Internationalized Domain Names (IDN) Mitigation APIs 1.1 is required:
+
+    http://www.microsoft.com/downloads/details.aspx?FamilyId=AD6158D7-DDBA-416A-9109-07607425A815&displaylang=en
+
 The NSIS installer requires about 14 MB of storage. The following 
 version is supported:
 
@@ -100,10 +98,6 @@ version is supported:
     Wix 2.0.5325.0
       http://prdownloads.sourceforge.net/wix/sources-2.0.5325.0.zip
 
-The InstallShield scripts (although not supported) require version 5.5
-of InstallShiled. Version 6.0 or higher of InstallShield are not 
-compatible.
-
 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.
@@ -115,13 +109,13 @@ 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.3.74 using the
+For this example, download source for version 1.5.51 using the
 following URL:
-http://www.openafs.org/dl/openafs/1.3.74/openafs-1.3.74-src.tar
+http://www.openafs.org/dl/openafs/1.5.51/openafs-1.5.51-src.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.3.74. Once
+your build based on a release version of the source, e.g. 1.5.51. Once
 you have completed a build process successfully, you can experiment with
 other source trees.
 
@@ -129,24 +123,24 @@ 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.3.74-src.tar) into target
+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.3.74\src
+    c:\OpenAFS\OpenAFS-1.5.51\src
 
 Copy the files 'NTMakefile' and 'ntbuild.bat' from 'src' to the OpenAFS 
 base directory (aka %AFSROOT%):
 
   From a DOS command prompt window, enter the following copy commands:
 
-    cd c:\OpenAFS\OpenAFS-1.3.74
+    cd c:\OpenAFS\OpenAFS-1.5.51
     copy src\NTMakefile .
     copy src\ntbuild.bat .
 
 
 The OpenAFS base directory should look something like the following:
 
-  c:\OpenAFS\OpenAFS-1.3.74\
+  c:\OpenAFS\OpenAFS-1.5.51\
     NTMakefile
     ntbuild.bat
     src
@@ -155,7 +149,9 @@ The OpenAFS base directory should look something like the following:
 STEP B. Install compiler and development tools.
 
 Install a copy of Microsoft Visual Studio .NET, Visual Studio .NET 2003, 
-or Visual Studio .NET 2005.  The "Typical" install setting is sufficient.
+or Visual Studio .NET 2005.  Visual Studio 2008 has not been sufficiently
+tested to be considered "supported".  The "Typical" install setting is 
+sufficient.
 
 (1) You can reduce the installation size by selecting "Custom" install
 and remove all but the following Options:
@@ -168,22 +164,29 @@ and remove all but the following Options:
 
 STEP C. Install SDK header files.
 
-Files from Microsoft's Platform SDK for Windows XP SP2 or Server 2003 are
-required to complete a build on Windows 2000/XP/2003.   You can install 
-the "Core, Data Access and Installer SDKs" from
+Files from Microsoft's Platform SDK for Windows Server 2003 SP1 are
+required to complete a build on Windows 2000/XP/2003.   At a minimum the
+following componets are known to be required: 
+
+  * Core
+  * Data Access
+  * Installer
+  * Windows Management Instrumentation
+  * Web Workshop (IE)
+
+It is advised that you install the entire SDK.  The SDK can be obtained
+from:
 
   http://www.microsoft.com/msdownload/platformsdk/sdkupdate/
 
 by using Internet Explorer 5.x or higher.  (Active X controls are required)
-If you do not which to use IE a complete SDK package is available from
-
-  http://www.microsoft.com/msdownload/platformsdk/sdkupdate/XPSP2FULLInstall.htm
 
 The header files that are required from a Microsoft SDK/DDK are:
 
    npapi.h    (Windows 2000,XP,2003 builds)
    netcfgx.h  (NSIS Loopback Adapter installer - Windows 2000,XP,2003 builds)
    netcfgn.h  (NSIS Loopback Adapter installer - Windows 2000,XP,2003 builds)
+   normalization.h (AFS Cache Manager)
 
 These files come from the following Microsoft DDKs/SDKs:
 
@@ -193,11 +196,8 @@ These files come from the following Microsoft DDKs/SDKs:
    netcfgn.h, netcfgx.h:
         Windows XP/2003 DDK - inc/wxp/
 
-If you are interested in experimenting with the IFS you must purchase from
-Microsoft a copy of the Windows 2003 SP1 IFS Kit.
-
-  http://www.microsoft.com/whdc/devtools/ifskit/default.mspx
-
+   normalization.h:
+        Microsoft IDN Mitigation APIs 1.1 - include/
 
 STEP D. Configure NTBUILD.BAT.
 
@@ -209,6 +209,7 @@ must be defined to match your configuration:
              Set to 1300 if using MS Visual Studio .NET
              Set to 1310 if using MS Visual Studio .NET 2003
              Set to 1400 if using MS Visual Studio .NET 2005
+             Set to 1500 if using MS Visual Studio 2008
 
   MSVCDIR: Set to the short name version of the directory into which
            the visual C++ compiler was installed regardless of version
@@ -233,6 +234,12 @@ must be defined to match your configuration:
 
   MSVCVer:  Set to 8.0 if using Visual Studio 8
 
+  CODESIGN_DESC: Product Name
+  
+  CODESIGN_TIMESTAMP: Time Stamp Service for Code Signing Certificate
+   
+  CODESIGN_URL: Support URL Displayed to End Users
+
 
 STEP E. Set version and installation options (optional)
 
@@ -252,12 +259,12 @@ Edit file %AFSROOT%\src\config\NTMakefile.i386_w2k
     CELLNAME_DEFAULT     - The default home cell name.
     CELLSERVDB_WEB       - The default web address to obtain CellServDB
 
-For example: in the file %AFSROOT%\src\config\NTMakefile.i386_nt40 you would
+For example: in the file %AFSROOT%\src\config\NTMakefile.i386_w2k you would
 see the following:
 
    AFSPRODUCT_VER_MAJOR=1
-   AFSPRODUCT_VER_MINOR=3
-   AFSPRODUCT_VER_PATCH=7400
+   AFSPRODUCT_VER_MINOR=5
+   AFSPRODUCT_VER_PATCH=5100
    AFSPRODUCT_VER_BUILD=0
    CELLNAME_DEFAULT=openafs.org
    CELLSERVDB_INSTALL=CellServDB.GrandCentral
@@ -284,15 +291,6 @@ STEP F. Begin the build
 
     (c) Execute the NTBUILD.BAT file with the parameter "free"
 
-    For a release build (IFS version):
-
-    (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
-        Visual Studio environment you installed.
-
-    (b) Execute the SETENV.BAT file with the parameters "/2000 /RETAIL"
-
-    (c) Execute the NTBUILD.BAT file with the parameter "free ifs"
-
     For a debug build (SMB version):
 
     (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
@@ -302,15 +300,6 @@ STEP F. Begin the build
 
     (c) Execute the NTBUILD.BAT file with the parameter "checked"
 
-    For a debug build (IFS version):
-
-    (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
-        Visual Studio environment you installed.
-
-    (b) Execute the SETENV.BAT file with the parameters "/2000 /DEBUG"
-
-    (c) Execute the NTBUILD.BAT file with the parameter "checked ifs"
-
 (4) Clean the work area:
 
     nmake /f NTMakefile clean
@@ -324,9 +313,6 @@ 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'.
 
-(6) [IFS only] Open a DDK/IFS Build Environment command window, change 
-    to the src\WINNT\afsrdr directory, and execute the "build" command.
-
 
 STEP G. Install NSIS 2.30 (optional).