From 5a226678d8d176c772107e2adab50b127bbf3de6 Mon Sep 17 00:00:00 2001 From: Dave Abrahams Date: Mon, 20 Nov 2006 13:14:36 +0000 Subject: [PATCH] some cleanups, add the Jamfile [SVN r36108] --- more/Jamfile.v2 | 23 +++++++++++++++++++++++ more/getting_started.html | 31 ++++++++++++++++--------------- more/getting_started.rst | 30 +++++++++++++++--------------- 3 files changed, 54 insertions(+), 30 deletions(-) create mode 100644 more/Jamfile.v2 diff --git a/more/Jamfile.v2 b/more/Jamfile.v2 new file mode 100644 index 0000000000..de5365006e --- /dev/null +++ b/more/Jamfile.v2 @@ -0,0 +1,23 @@ +# Copyright David Abrahams 2006. Distributed under the Boost +# Software License, Version 1.0. (See accompanying +# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +import docutils ; + +import path ; +sources = getting_started.rst ; +bases = $(sources:S=) ; + +# This is a path relative to the html/ subdirectory where the +# generated output will eventually be moved. +stylesheet = "--stylesheet=../rst.css" ; + +for local b in $(bases) +{ + html $(b) : $(b).rst : + + "-gdt --source-url="./$(b).rst" --link-stylesheet --traceback --trim-footnote-reference-space --footnote-references=superscript "$(stylesheet) + ; +} + +alias htmls : $(bases) ; +stage . : $(bases) ; diff --git a/more/getting_started.html b/more/getting_started.html index f0890f3a57..3cab7ff012 100644 --- a/more/getting_started.html +++ b/more/getting_started.html @@ -498,14 +498,14 @@ purpose in your current working directory.

Change your current directory to the Boost root directory and invoke bjam as follows:

-bjam --build-dir=build-directory \
+bjam --build-dir=build-directory \
      --toolset=toolset-name stage

For example, on Windows, your session might look like:

 C:WINDOWS> cd C:\Program Files\boost\boost_1_34_0
-C:\Program Files\boost\boost_1_34_0> bjam \
-  --build-dir=%HOMEDRIVE%%HOMEPATH%\build-boost  \
+C:\Program Files\boost\boost_1_34_0> bjam   \
+  --build-dir=%HOMEDRIVE%%HOMEPATH%\build-boost    \
   --toolset=msvc stage
@@ -529,7 +529,7 @@ prefer not to create an additional copy, instead of installing Boost you can simply “stage” the Boost binaries, which leaves them in the stage/ subdirectory of your chosen build directory:

-bjam --build-dir=build-directory \
+bjam --build-dir=build-directory   \
      --toolset=toolset-name stage
@@ -544,21 +544,21 @@ leave you with the following subdirectories of the prefix directory:

Change your current directory to the Boost root directory and invoke bjam as follows:

-bjam --build-dir=build-directory \
-     --toolset=toolset-name      \
+bjam --build-dir=build-directory   \
+     --toolset=toolset-name        \
       --prefix=prefix-directory install

For example, on Windows your session might look like:

 C:WINDOWS> cd C:\Program Files\boost\boost_1_34_0
-C:\Program Files\boost\boost_1_34_0> bjam \
-    --build-dir=C:\TEMP\build-boost       \
+C:\Program Files\boost\boost_1_34_0> bjam   \
+    --build-dir=C:\TEMP\build-boost         \
     --prefix=C:\boost

And on Unix:

 ~$ cd ~/boost_1_34_0
-~/boost_1_34_0$ bjam --build-dir=/tmp/build-boost \
+~/boost_1_34_0$ bjam --build-dir=/tmp/build-boost \
      --prefix=~/boost
@@ -620,16 +620,16 @@ auto-linking:

For example, we can compile and link the above program from the Visual C++ command-line by simply adding the bold text below to the command line we used earlier, assuming your Boost binaries are -in C:\Program Files\boost\boost_1_34_0:

+in C:\Program Files\boost\boost_1_34_0\lib:

-C:PROMPT> cl /EHsc /I C:\path\to\boost_1_34_0 example.cpp \
-     /link /LIBPATH: C:\Program Files\boost\boost_1_34_0
+C:PROMPT> cl /EHsc /I C:\path\to\boost_1_34_0 example.cpp   \
+     /link /LIBPATH: C:\Program Files\boost\boost_1_34_0\lib

To link with a library that doesn't use auto-linking support, you need to specify the library name. For example,

-C:PROMPT> cl /EHsc /I C:\path\to\boost_1_34_0 example.cpp \
-     /link /LIBPATH: C:\Program Files\boost\boost_1_34_0 \
+C:PROMPT> cl /EHsc /I C:\path\to\boost_1_34_0 example.cpp   \
+     /link /LIBPATH: C:\Program Files\boost\boost_1_34_0    \
      boost_regex-msvc-7.1-mt-d-1_34.lib

See Library Naming for details about how to select the right @@ -834,7 +834,8 @@ recommend it.

-Generated on: 2006-11-20 04:00 UTC. +View document source. +Generated on: 2006-11-20 13:06 UTC. Generated by Docutils from reStructuredText source.
diff --git a/more/getting_started.rst b/more/getting_started.rst index ae3b1f6e20..6f314556f1 100644 --- a/more/getting_started.rst +++ b/more/getting_started.rst @@ -23,7 +23,7 @@ Have fun! .. |root| replace:: ``/``\ *path*\ ``/``\ *to*\ ``/``\ |boost_ver| .. |winroot| replace:: *C:*\ ``\``\ *path*\ ``\``\ *to*\ ``\``\ |boost_ver| .. |winroot-default| replace:: ``C:\Program Files\boost\``\ |boost_ver| -.. |bold-winroot-default| replace:: **C:\\Program Files\\boost\\**\ |boost_ver| +.. |bold-winroot-default| replace:: **C:\\Program Files\\boost\\**\ |boost_ver-bold| Getting Boost ============= @@ -511,7 +511,7 @@ invoke ``bjam`` as follows: .. parsed-literal:: - bjam --build-dir=\ |build-directory|_ \\ + bjam --build-dir=\ |build-directory|_ **\\** --toolset=\ |toolset-name|_ stage For example, on Windows, your session might look like: @@ -519,8 +519,8 @@ For example, on Windows, your session might look like: .. parsed-literal:: C:\WINDOWS> cd |winroot-default| - |winroot-default|> bjam \\ - **--build-dir=**\ %HOMEDRIVE%%HOMEPATH%\\build-boost \\ + |winroot-default|> bjam **\\** + **--build-dir=**\ %HOMEDRIVE%%HOMEPATH%\\build-boost **\\** **--toolset=msvc stage** .. Note:: ``bjam`` is case-sensitive; it is important that all the @@ -547,7 +547,7 @@ in the ``stage/`` subdirectory of your chosen `build directory`_: .. parsed-literal:: - bjam --build-dir=\ |build-directory|_ \\ + bjam --build-dir=\ |build-directory|_ **\\** --toolset=\ |toolset-name|_ stage .. _prefix directory: @@ -569,8 +569,8 @@ invoke ``bjam`` as follows: .. parsed-literal:: - bjam --build-dir=\ |build-directory|_ \\ - --toolset=\ |toolset-name|_ \\ + bjam --build-dir=\ |build-directory|_ **\\** + --toolset=\ |toolset-name|_ **\\** --prefix=\ |prefix-directory|_ install For example, on Windows your session might look like: @@ -578,8 +578,8 @@ For example, on Windows your session might look like: .. parsed-literal:: C:\WINDOWS> cd |winroot-default| - |winroot-default|> bjam \\ - --build-dir=C:\\TEMP\\build-boost \\ + |winroot-default|> bjam **\\** + --build-dir=C:\\TEMP\\build-boost **\\** --prefix=C:\\boost And on Unix: @@ -587,7 +587,7 @@ And on Unix: .. parsed-literal:: ~$ cd ~/|boost_ver| - ~/|boost_ver|\ $ bjam --build-dir=/tmp/build-boost \\ + ~/|boost_ver|\ $ bjam --build-dir=/tmp/build-boost **\\** --prefix=~/boost Linking A Program with a Boost Library @@ -650,20 +650,20 @@ Visual C++ Command Line For example, we can compile and link the above program from the Visual C++ command-line by simply adding the **bold** text below to the command line we used earlier, assuming your Boost binaries are -in |winroot-default|: +in |winroot-default|\ ``\lib``: .. parsed-literal:: - C:\PROMPT> cl /EHsc /I |winroot| example.cpp **\\** - **/link /LIBPATH:** |bold-winroot-default| + C:\PROMPT> cl /EHsc /I |winroot| example.cpp **\\** + **/link /LIBPATH:** |bold-winroot-default|\ **\\lib** To link with a library that doesn't use auto-linking support, you need to specify the library name. For example, .. parsed-literal:: - C:\PROMPT> cl /EHsc /I |winroot| example.cpp \\ - /link /LIBPATH: |winroot-default| **\\** + C:\PROMPT> cl /EHsc /I |winroot| example.cpp **\\** + /link /LIBPATH: |winroot-default| **\\** **boost_regex-msvc-7.1-mt-d-1_34.lib** See `Library Naming`_ for details about how to select the right