Update INSTALL with boost profile instructions

1 files changed, 47 insertions, 39 deletions

diff --git a/INSTALL b/INSTALL
index 82a97fc..10445a7 100644
--- a/INSTALL
+++ b/INSTALL
@@ -5,11 +5,13 @@ system you would like to use. Valid values for <database> are:
 
 Prerequisites
 =============
-  
-  - odb                http://www.codesynthesis.com/products/odb/
-  - libodb             http://www.codesynthesis.com/products/odb/
-  - libodb-tracer      http://www.codesynthesis.com/products/odb/
-  - libodb-<database>  http://www.codesynthesis.com/products/odb/  
+
+  - odb                     http://www.codesynthesis.com/products/odb/
+  - libodb                  http://www.codesynthesis.com/products/odb/
+  - libodb-tracer           http://www.codesynthesis.com/products/odb/
+  - libodb-<database>       http://www.codesynthesis.com/products/odb/
+  - libodb-boost (optional) http://www.codesynthesis.com/products/odb/
+  - boost (optional)        http://www.boost.org
 
 Building on UNIX
 ================
@@ -17,7 +19,7 @@ Building on UNIX
 The following build instructions are for the Linux/UNIX/Mac OS X
 operating systems as well as for Cygwin and MinGW on Windows.
 
-The standard autotools-based build system is used on these platforms. 
+The standard autotools-based build system is used on these platforms.
 After unpacking the source code archive, change to the odb-tests
 package directory (referred to as odb-tests/ from now on) and run
 the configure script, for example:
@@ -45,26 +47,30 @@ option to specify the build directory, for example:
 
 ./configure --with-odb=/tmp/odb
 
-The configure script also expects the libodb, libodb-tracer, and
-libodb-<database> headers and libraries to be installed in a directory
-where the C++ compiler and linker will search for them by default
-(normally /usr and /usr/local). If these libraries are installed in
-other directories, you can use the CPPFLAGS and LDFLAGS configure
-variables to specify their locations, for example:
+The configure script also expects the libodb, libodb-tracer,
+libodb-<database>, and, if you would like to build the boost profile tests,
+libodb-boost and boost headers and libraries to be installed in a directory
+where the C++ compiler and linker will search for them by default (normally
+/usr and /usr/local). If these libraries are installed in other directories,
+you can use the CPPFLAGS and LDFLAGS configure variables to specify their
+locations, for example:
 
 ./configure CPPFLAGS=-I/opt/libodb/include LDFLAGS=-L/opt/libodb/lib
 
-If these libraries are not installed and you would like to use their 
-build directories instead, you can use the --with-libodb, 
---with-libodb-tracer, and --with-libodb-<database> configure options
-to specify their locations, for example:
+If these libraries are not installed and you would like to use their
+build directories instead, you can use the --with-libodb,
+--with-libodb-tracer, --with-libodb-<database>, --with-libodb-boost, and
+--with-boost configure options to specify their locations, for example:
 
 ./configure --with-libodb=/tmp/libodb
 
+For the boost build directory the configure script expects to find the
+boost libraries in the stage/lib/ subdirectory.
+
 For each <database> value the configure script has a set of options in
 the form --with-<database>-* that allow you to specify various database
 system parameters, such as the login name, password, and database name,
-that should be used when running the tests. Run configure with 
+that should be used when running the tests. Run configure with
 --help to see the available options for your database.
 
 As another example, the following configure command uses the specified
@@ -93,38 +99,40 @@ The standard Visual Studio project and solution files are used on this
 platform. The provided project files expect the directory where the ODB
 compiler binary is installed to be in the executable search path (the
 PATH environment variable). They also expect the libodb, libodb-tracer,
-and libodb-<database> header and import library directories to be in
-the VC++ Directories Include and Library search lists. See the INSTALL
-files in the library packages for more information on how to setup the
-VC++ Directories.
+libodb-<database>, and, if you would like to build the boost profile tests,
+libodb-boost and boost header and import library directories to be in the
+VC++ Directories Include and Library search lists. See the INSTALL files
+in the ODB library packages for more information on how to setup their
+VC++ Directories. For boost, refer to the boost documentation.
 
 There are two ways to build the tests with Visual Studio. After unpacking
-the source code archive, you can manually open three solution files located
-in the tracer\, common\, and <database>\ directories in the odb-tests package
-directory (referred to as odb-tests\ from now on). In the tracer\ directory
-the solution file is named tracer-vc<N>.sln. In the common\ directory it
-is named common-<database>-vc<N>.sln. And in the <database>\ directory it
-is named <database>-vc<N>.sln. Here <N> is the version of Visual Studio
-that you are using. Once each solution is open, select the desired build
-configuration (Debug or Release) and platform (Win32 or x64) and build the
-solution.
-
-Alternatively, you can use the build.bat batch file located in the odb-tests\
-directory to build all the solutions, for all the configurations and for all
-the platforms automatically. The build.bat file has the following command
-line interface:
-
-build.bat <database> <N> [/Build|/Clean|/Rebuild] 
+the source code archive, you can manually open solution files located in
+the tracer\, common\, <database>\, boost\common\, and boost\<database>\
+directories in the odb-tests package directory (referred to as odb-tests\
+from now on). In the tracer\ directory the solution file is named
+tracer-vc<N>.sln. In the common\ and boost\common\ directories they are
+named common-<database>-vc<N>.sln. And in the <database>\ and boost\<database>\
+directories they are named <database>-vc<N>.sln. Here <N> is the version of
+Visual Studio that you are using. Once each solution is open, select the
+desired build configuration (Debug or Release) and platform (Win32 or x64)
+and build the solution.
+
+Alternatively, you can use the build.bat batch files located in the odb-tests\
+and odb-tests\boost\ directories to build all the solutions, for all the
+configurations and for all the platforms automatically. The build.bat file
+has the following command line interface:
+
+build.bat <database> <N> [/Build|/Clean|/Rebuild]
 
 Where <N> is the version of Visual Studio that you are using. If no action
 is specified, the default is /Build.
 
-Once the build is completeed successfully, you can run all the tests using
+Once the build is completed successfully, you can run all the tests using
 the test.bat batch file located in the odb-tests\ directory.
 
 Before you can run test.bat, you may need to adjust the database system
 parameters, such as the login name, password, and database name, that
-should be used when running the tests. To do this, edit the 
+should be used when running the tests. To do this, edit the
 <database>.options and <database>-driver.bat files located in the
 odb-tests\ directory. Once this is, done you can run the tests by
 executing the following command from the command prompt: