From: Vladimir Prus (ghost_at_[hidden])
Date: 2006-04-25 06:08:12
On Monday 03 April 2006 21:00, Richard Peters wrote:
> These are the documentation nitpicks of boost.jam. I've tried to
> correct most of them myself, and the results are in the attached diff.txt
> (and available on http://rpeters.org/jamdiff.txt ), but since I'm not at
> all familiar with the quickbook format, I didn't apply changes that affect
> quickbook syntax, but described here what the changes are:
I've applied this patch. Again, thanks for thorough proofreading!
> line 268: =bjam\[.exe\]= generates literally bjam\[.exe\], including the
> backslashes. I'm not familiar with the quickbook format. Can these simply
> be removed?
Appears to work fine without backslashes.
> line 399 and at other places, documentation speaks of 'built targets'.
> Shouldn't these be 'build targets', meaning targets that are part of a
> build, instead of targets that are already built?
I'm not sure. "Built targets" can be read as "targets that will be built". Can
native speakers say something?
> line 441: A backslash (\): the backslash is not visible in the generated
> documentation. Should probably be escaped with another backslash.
Using double backslash works.
> The Lexical Features section of the Language section does not mention
> comments. I didn't find a description of how comments look like like
> line 457: Same as in line 268, backslashes are displayed four times.
> line 764: PROFILE is used as rulename, but shouldn't that be W32_GETREG?
> line 918: [^=] is expected to generate = but doesn't do it. Instead, it
> causes ] to display and makes the rest of the line use the wrong font.
> [^+=] later in the line has the same problem.
> line 996: the code is on the same line as the paragraph.
> line 1423: "Note that the documentation" Which documentation? This
> documentation or the original jam documentation?
Change to "original Jam documentation".
> line 1448: The formatting is wrong.
-- Vladimir Prus http://vladimir_prus.blogspot.com Boost.Build V2: http://boost.org/boost-build2
Boost-Build list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk