Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r53704 - trunk/tools/jam/doc
From: ghost_at_[hidden]
Date: 2009-06-07 04:57:13

Author: vladimir_prus
Date: 2009-06-07 04:57:11 EDT (Sun, 07 Jun 2009)
New Revision: 53704

Clarify that Boost.Jam is low-level engine for Boost.Build.

This includes big warning that Boost.Build docs are better
be read, explanation that Boost.Jam is not meant as classic Jam
replacement, and removal of Jam-as-standalone-build-system

Text files modified:
   trunk/tools/jam/doc/bjam.qbk | 28 +++++++++-------------------
   1 files changed, 9 insertions(+), 19 deletions(-)

Modified: trunk/tools/jam/doc/bjam.qbk
--- trunk/tools/jam/doc/bjam.qbk (original)
+++ trunk/tools/jam/doc/bjam.qbk 2009-06-07 04:57:11 EDT (Sun, 07 Jun 2009)
@@ -46,7 +46,15 @@
 [section:intro Introduction]
-Boost.Jam (BJam) is a build tool based on FTJam, which in turn is based on :Perforce_Jam:. It contains significant improvements made to facilitate its use in the Boost Build System, but should be backward compatible with :Perforce_Jam:.
+[warning Most probably, you are looking for [@ Boost.Build
+manual]. This document is not meant to be read standalone and will only
+confuse you. Boost.Build manual refers to specific sections when necessary.]
+Boost.Jam (BJam) is the low-level build engine tool for
+[@ Boost.Build]. Historically, Boost.Jam is based
+on on FTJam and on :Perforce_Jam: but has grown a number of significant
+features and is now developed independently, with no merge back expected to
+happen, and little use outside Boost.Build.
 This is version :version: of BJam and is based on version 2.4 of Jam/MR:
@@ -61,24 +69,6 @@
-[section:features Features]
-Jam is a make(1) replacement that makes building simple things simple and building complicated things manageable.
-Jam's language is expressive, making Jamfiles (c.f. Makefiles) compact.
-Jam handles header file dependencies automatically and on-the-fly.
-Jam is very portable: it runs on UNIX, VMS, Mac, and NT. Most Jamfiles themselves are portable.
-Jam is unintrusive: it is small, it has negligible CPU overhead, and it doesn't create any of its own funny files (c.f. Odin, nmake, SunOS make).
-Jam can build large projects spread across many directories in one pass, without recursing, tracking the relationships among all files. Jam can do this with multiple, concurrent processes.
-Jam isn't under the blinkin GNU copyright, so you can incorporate it into commercial products.
 [section:building Building BJam]

Boost-Commit list run by bdawes at, david.abrahams at, gregod at, cpdaniel at, john at