Update build instructions to describe CMake build mechanism

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@788527 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 47 insertions, 26 deletions

diff --git a/cpp/INSTALL-WINDOWS b/cpp/INSTALL-WINDOWS
index 3ac76509f3..e4e1c6b1fc 100644
--- a/cpp/INSTALL-WINDOWS
+++ b/cpp/INSTALL-WINDOWS
@@ -18,12 +18,12 @@ Table of Contents
 

 1. Introduction

 ===============

-Note that the daemon and client API can be built and installed separately.

+Note that the broker and client API can be built and installed separately.

 They both link against a common library.

 

-This document describes how to build the Qpid/C++ broker and client, either

-from a checkout of the source or from a source distribution, on Windows using

-Microsoft Visual Studio 2008 (VC9).

+This document describes how to build the Qpid/C++ broker and client on

+Windows using Microsoft Visual Studio 2008 (VC9). It describes how to build

+from both a checkout of the source and from a source distribution.

 

 Please see INSTALL for information on building on Linux/UNIX.

 

@@ -32,23 +32,27 @@ Please see INSTALL for information on building on Linux/UNIX.
 ================

 We prefer to avoid spending time accommodating older versions of these

 packages, so please make sure that you have the latest stable versions.

-Known version numbers for a succesful build are given in brackets, take

-these as a recommended minimum version.

+Known version numbers for a successful build are given in parentheses.

+Take these as a recommended minimum version.

 

 2.1. What to Install

 ====================

 

 The following libraries and header files must be installed to build

-a source distribution:

+from either a source checkout or a source distribution:

+

  * boost      <http://www.boost.org>                   	(1.35)(*)

 

-(*) earlier versions of boost e.g. 1.33 also work

+earlier versions of boost e.g. 1.33 also work

+

+To build from a source repository (SVN) checkout you will need boost plus:

 

-If you want to build directly from the SVN repository you will need

-all of the above plus:

+ * CMake      <http://www.cmake.org>                    (2.4)

+ * python     <http://www.python.org>                   (2.5.2)

+ * ruby       <http://www.ruby-lang.org>               	(1.8.4)

 

- * python <http://www.python.org>                       (2.5.2)

- * ruby   <http://www.ruby-lang.org>               	(1.8.4)

+Regardless of which type of build you perform, if you wish to run the full

+test suite, you will need to have python, listed above, installed.

 

 2.2. Important Environment Variable Settings

 ============================================

@@ -58,7 +62,7 @@ manually installed to non-standard locations. For example:
  # set PATH=C:\python25;%PATH%

 

 It is also necessary to set BOOST_ROOT to refer to the base of your Boost

-installation. The Visual Studio build projects refer to it. For example:

+installation. The Visual Studio projects refer to it. For example:

 

  # set BOOST_ROOT=C:\Program Files\boost\boost_1_35_0

 

@@ -71,30 +75,47 @@ Visual Studio solution files. The procedure for all three is the same.
 Start the Visual Studio IDE and open the desired solution. They are located

 under the distribution directory in the following places:

 

-- broker/client:  src/qpid.sln

+- broker/client:  src/qpidc.sln

 - examples:       src/examples/examples.sln

 - tests:          src/tests/tests.sln

 

-Open the desired solution, select Debug/Release, and build.

-You can build both Release and Debug in the same directory.

+Open the desired solution, select Debug or Release, and build.

+You can build both Release and Debug from the same project.

 

 How to easily test????

 

 

 4. Building a Repository Working Copy

 =====================================

-To get the source code from the subversion repository (trunk) do:

+This section will assume that you will create a directory for your Qpid

+work. This directory will be referred to below as C:\qpid.

 

- # svn checkout https://svn.apache.org/repos/asf/incubator/qpid/trunk/.

-

-A large portion of the source code is generated using some contained

-scripts. The generated code is included in source distributions; however,

-when building a repository working copy this code must be generated.

-To generate the code and build a fresh checkout:

+To get the source code from the subversion repository (trunk) do:

 

-  Open a Visual Studio Command Prompt window

-  cd to the qpid\cpp\src directory

-  nmake /f protocol_gen.mak

+ C:\qpid> svn checkout https://svn.apache.org/repos/asf/incubator/qpid/trunk

+

+The first step in the build is to configure and generate the Visual

+Studio projects. This step also generates a significant number of source

+files that are part of the build. 

+

+- Run CMakeSetup. The CMake binary install often leaves a shortcut to

+  CMakeSetup on the desktop - it is named CMake.

+- The CMakeSetup window has 2 directory selection areas at the top; one for

+  where the source is located (C:\qpid\trunk\qpid\cpp) and one for where you

+  wish to place the build. A subdirectory of the source directory is generally

+  preferred (C:\qpid\trunk\qpid\cpp\build)

+- The first time you run CMakeSetup it will ask you to select a generator.

+  You should select the method you prefer to build with: Visual Studio 2008

+  or NMake Makefiles.

+- The Cache Values area of the window is where the system and build settings

+  are displayed. You can change these by clicking on the values if desired.

+- Click the Configure button. The first time Qpid is configured this step may

+  take a few minutes and you will see lots of messages about generated source

+  files. If the Cache Values area has any red lines, change or correct the

+  value if needed (it may only be red because it's new - you only need to

+  change/correct items that correspond to errors in configuration). Click

+  Configure again. Repeat until all the Cache Values are gray.

+- Click the OK button to generate the project/make files.

 

 Now follow instruction for building from a source distribution in step (3).