From fe54e4d5d006e592060ca2d12c3d786c558d7c82 Mon Sep 17 00:00:00 2001 From: Dave Abrahams Date: Tue, 12 Dec 2006 00:39:45 +0000 Subject: [PATCH] Improve (but don't fix) collision avoidance between |winroot-default| and sidebar on FireFox. Correct notes about library extensions for GCC on Windows. Correct broken links to reference material. [SVN r36336] --- getting_started.html | 88 +++++++++++++++++++++----------------------- getting_started.rst | 42 ++++++++++----------- 2 files changed, 63 insertions(+), 67 deletions(-) diff --git a/getting_started.html b/getting_started.html index 01f0d0c..6a69396 100644 --- a/getting_started.html +++ b/getting_started.html @@ -44,7 +44,7 @@
  • 7.4   Test Your Program
    • -
  • 8   Further Resources
    • +
  • 8   Conclusion and Further Resources
  • 9   Appendix: Using command-line tools in Windows
    • @@ -86,13 +86,6 @@ users.

    Windows users cover only the Visual Studio .NET 2003 and Visual Studio 2005. We hope that gives you enough information to adapt them for your own compiler or IDE.

    -
    -

    Onward

    -
    -

    Good luck, and have fun!

    -

    —the Boost Developers

    -
    -
    @@ -174,7 +167,7 @@ expect to find anything you can use.

    1. The path to the “boost root directory” is sometimes referred to as $BOOST_ROOT in documentation and mailing lists. If you -used the Windows installer, that will usually be C:\Program Files\boost\boost_1_34_0.

      +used the Windows installer, that will usually be C: \Program`` \ ``Files\boost\boost_1_34_0.

    2. To compile anything in Boost, you need a directory containing the boost/ subdirectory in your #include path. For most @@ -313,7 +306,7 @@ select Visual C++ > Win32.

      3. select Properties from the resulting pop-up menu
    3. In Configuration Properties > C/C++ > General > Additional Include Directories, enter the path to the Boost root directory, e.g. -C:\Program Files\boost\boost_1_34_0.
      4. +C: \Program`` \ ``Files\boost\boost_1_34_0.
    4. In Configuration Properties > C/C++ > Precompiled Headers, change Use Precompiled Header (/Yu) to Not Using Precompiled Headers.5
      5. @@ -347,7 +340,7 @@ you'll need library binaries.

      6.1   Install Visual Studio Binaries

      The Windows installer supplied by Boost Consulting will download and install pre-compiled binaries into the lib\ subdirectory of -the boost root, typically C:\Program Files\boost\boost_1_34_0\lib\.

      +the boost root, typically C: \Program`` \ ``Files\boost\boost_1_34_0\lib\.

      next...

    @@ -514,8 +507,8 @@ bjam --build-dir=build-di

    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 \
+C:WINDOWS> cd C: \Program`` \ ``Files\boost\boost_1_34_0
+C: \Program`` \ ``Files\boost\boost_1_34_0> bjam \
   --build-dir=%TEMP%\build-boost          \
   --toolset=msvc stage
    @@ -574,7 +567,7 @@ linker, consider setting up a use in the     Boost.Build documentation. If that isn't your problem or the user-config.jam file doesn't work for you, please address questions about configuring Boost for your compiler to the -Boost.Build mailing list.

    +Boost.Build mailing list.

    @@ -618,19 +611,18 @@ consider.

    7.1   Link to a Boost Library on Windows

    -

    Most Windows compilers and linkers have so called “auto-linking -support,” which is used by many Boost libraries to eliminate the -second challenge. Special code in Boost header files detects your -compiler options and uses that information to encode the name of -the correct library into your object files; the linker selects the -library with that name from the directories you've told it to -search.

    +

    Most Windows compilers and linkers have so-called “auto-linking +support,” which eliminates the second challenge. Special code in +Boost header files detects your compiler options and uses that +information to encode the name of the correct library into your +object files; the linker selects the library with that name from +the directories you've told it to search.

    Link to a Boost Library from the Visual Studio Command Prompt

    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\lib:

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

     cl /EHsc /I path\to\boost_1_34_0 example.cpp   \
      /link /LIBPATH: C:\Program Files\boost\boost_1_34_0\lib
@@ -646,7 +638,7 @@ earlier:
    
 select Properties from the resulting pop-up menu
 
  • In Configuration Properties > Linker > Additional Library
 Directories, enter the path to the Boost binaries,
-e.g. C:\Program Files\boost\boost_1_34_0\lib\.
    • 
+e.g. C: \Program`` \ ``Files\boost\boost_1_34_0\lib\.
 
  • From the Build menu, select Build Solution.
    • 
 
 
    next...
    
@@ -753,14 +745,15 @@ replaced by underscores. For example, version 1.31.1 would be
 tagged as "-1_31_1".
 
    .lib
    
 
    Extension: determined according to the
-operating system's usual convention.  On Windows, .dll
-indicates a shared library and .lib indicates a static or
-import library.  On most *nix platforms the extensions are
+operating system's usual convention.  On most *nix platforms the extensions are
 .a and .so for static libraries (archives) and shared
-libraries, respectively.  Where supported by *nix toolsets, a
-full version extension is added (e.g. ".so.1.34"); a symbolic
-link to the library file, named without the trailing version
-number, will also be created.
    
+libraries, respectively.  On Windows—except for libraries built
+by gcc toolset, which always uses the *nix
+convention—``.dll`` indicates a shared library and .lib
+indicates a static or import library.  Where supported by *nix
+toolsets, a full version extension is added (e.g. ".so.1.34"); a
+symbolic link to the library file, named without the trailing
+version number, will also be created.
    @@ -813,25 +806,28 @@ Spoil Rock Hunter?”

    -

    8   Further Resources

    -

    This concludes your introduction to Boost and using it with your -programs. Remember that this page is only supposed to get you -started and not describe every detail you might want to know about. -There are lots of resources you can pursue from this point onward. +

    8   Conclusion and Further Resources

    +

    This concludes your introduction to Boost and to integrating it +with your programs. As you start using Boost in earnest, there are +surely a few additional points you'll wish we had covered. One day +we may have a “Book 2 in the Getting Started series” that addresses +them. Until then, we suggest you pursue the following resources. If you can't find what you need, or there's anything we can do to -make this document clearer, please post it to the Boost Users' +make this document clearer, please post it to the Boost Users' mailing list.

    -
    -

    Note

    -

    We're also very interested in what sort of material might -be appropriate for a “Book 2” in a Getting Started series.

    +
    +

    Onward

    +
    +

    Good luck, and have fun!

    +

    —the Boost Developers

    +
    @@ -849,7 +845,7 @@ cd path\to\some\directory

    followed by Return. For example,

    -cd C:\Program Files\boost\boost_1_34_0
+cd C: \Program`` \ ``Files\boost\boost_1_34_0

    One way to name a directory you know about is to write

    @@ -948,7 +944,7 @@ recommend it.
 
    
 
    
 View document source.
-Generated on: 2006-12-11 20:27 UTC.
+Generated on: 2006-12-12 00:28 UTC.
 Generated by Docutils from reStructuredText source.
 
 
    
diff --git a/getting_started.rst b/getting_started.rst
index 6cb0fe2..131d7ee 100644
--- a/getting_started.rst
+++ b/getting_started.rst
@@ -23,7 +23,7 @@ __ ../index.htm
 
 .. |root| replace:: ``/``\ *path*\ ``/``\ *to*\ ``/``\ |boost_ver|
 .. |winroot| replace:: *path*\ ``\``\ *to*\ ``\``\ |boost_ver|
-.. |winroot-default| replace:: ``C:\Program Files\boost\``\ |boost_ver|
+.. |winroot-default| replace:: ``C:\Program``\ `` ``\ ``Files\boost\``\ |boost_ver|
 .. |bold-winroot-default| replace:: **C:\\Program Files\\boost\\**\ |boost_ver-bold|
 
 Introduction
@@ -663,13 +663,12 @@ Link to a Boost Library on Windows
 
 .. _auto-linking:
 
-Most Windows compilers and linkers have so called “auto-linking
-support,” which is used by many Boost libraries to eliminate the
-second challenge.  Special code in Boost header files detects your
-compiler options and uses that information to encode the name of
-the correct library into your object files; the linker selects the
-library with that name from the directories you've told it to
-search.
+Most Windows compilers and linkers have so-called “auto-linking
+support,” which eliminates the second challenge.  Special code in
+Boost header files detects your compiler options and uses that
+information to encode the name of the correct library into your
+object files; the linker selects the library with that name from
+the directories you've told it to search.
 
 Link to a Boost Library from the Visual Studio Command Prompt
 .............................................................
@@ -806,15 +805,16 @@ following elements:
   tagged as "-1_31_1".
 
 ``.lib``
-  *Extension*: determined according to the
-  operating system's usual convention.  On Windows, ``.dll``
-  indicates a shared library and ``.lib`` indicates a static or
-  import library.  On most \*nix platforms the extensions are
-  ``.a`` and ``.so`` for static libraries (archives) and shared
-  libraries, respectively.  Where supported by \*nix toolsets, a
-  full version extension is added (e.g. ".so.1.34"); a symbolic
-  link to the library file, named without the trailing version
-  number, will also be created.
+  *Extension*: determined according to the operating system's usual
+  convention.  On most \*nix platforms the extensions are ``.a``
+  and ``.so`` for static libraries (archives) and shared libraries,
+  respectively.  On Windows, ``.dll`` indicates a shared library
+  and—except for static libraries built by ``gcc`` toolset, whose
+  names always end in ``.a``— ``.lib`` indicates a static or import
+  library.  Where supported by \*nix toolsets, a full version
+  extension is added (e.g. ".so.1.34") and a symbolic link to the
+  library file, named without the trailing version number, will
+  also be created.
 
 .. _Boost.Build toolset names: toolset-name_
 
@@ -904,11 +904,11 @@ mailing list`_.
 
      -- the Boost Developers
 
-.. _Boost.Build reference manual: http://boost.org/tools/build/v2
-.. _Boost.Jam reference manual: http://boost.org/tools/jam
-.. _Boost Users' mailing list: http://boost.org/more/mailing_lists.htm#users
+.. _Boost.Build reference manual: ../tools/build/v2
+.. _Boost.Jam reference manual: `Boost.Jam`_
+.. _Boost Users' mailing list: mailing_lists.htm#users
 .. _Boost.Build Wiki: http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Boost.Build_V2
-.. _Boost.Build mailing list: http://boost.org/more/mailing_lists.htm#jamboost
+.. _Boost.Build mailing list: mailing_lists.htm#jamboost
 
 
 .. _`Using command-line tools in Windows`: