[boost] Re: Documentation for build+install for users.

From: David Abrahams (dave_at_[hidden])
Date: 2003-11-18 15:31:11

Rene Rivera <grafik.list_at_[hidden]> writes:

> Boosters,
>
> I finally finished, yes it took a while but it's been busy, a "Getting
> Started" document to guide users in building and installing Boost with the
> new system. The document is in CVS as boost-root/more/getting_started.html
>
> Comments are welcome.

The link "build it yourself" leads to a section called "Installing" at
tools/build/jam_src/index.html#installing I've always thought that was
confusing, especially because we're in a document about installing
Boost.  Could we rename the section "Building Boost.Jam" or "Building
bjam"?

        "The user doesn't want his environment cluttered with settings
        or has nonstandard installations for some of his
        tools. Instead, he or she sets variables which point to the
        toolset installation directories, either in the command shell
        environment or on the bjam command-line. These variables are
        used by the build system to locate the tools and invoke the
        necessary setup."

We should describe how to set a variable on the bjam command-line.

          "-sTOOLS=<toolsets>   The list of tools to compile
          with. Usually only one is needed. You can specify more than
          one by separating them with spaces"

We should note that you need quotes around the whole command-line
argument.

Something looks strange about the diagram in the "results" section.
Was the enclosed what you intended?  Note the placement of dashes.



> This document is meant to replace information that was spread out in various
> other places into hopefully an easier to follow single set of instructions.
> It should replace the "Download", and "Install & Build" entries on the main
> page. That is if people are agreeable to that ;-)

Good idea!

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