Re: [BBv2 docs editorial] Installation

From: David Abrahams (dave_at_[hidden])
Date: 2005-09-21 10:21:44

Vladimir Prus <ghost_at_[hidden]> writes:

> On Wednesday 21 September 2005 05:17, Andrey Melnikov wrote:
>> See http://tinyurl.com/aaf5e . I implemented all the changes suggested
>> by you and me.
>
> Looks fine for me. Except that we don't have prebuilt Solaris binary, as far 
> as I can tell.
>
> Is this version fine with everybody?

No, phrasing like this is going to make people think we're sadists:

If your platform isn't in the list, or if you downloaded the
latest Boost beta sources from CVS instead of an official Boost
release, installation guide describes how to compile bjam from
sources located in tools/build/jam_src or jam_src by running
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
build.bat or build.sh.
^^^^^^^^^^^^^^^^^^^^^

The reader doesn't know if these two pairs of alternatives are related
and doesn't know why we're giving them two options for finding the
sources.

Furthermore, the installation guide describes how to compile bjam from
sources regardless of whether your platform is in the list, etc.

If your platform isn't in the list or you are using the latest
Boost sources rather than an official release, see Chapter XX,
Installation Guide for instructions on how to compile bjam from
source.

-- 
Dave Abrahams
Boost Consulting
www.boost-consulting.com