Re: [Boost-docs] Boost-wide concept docs

Subject: Re: [Boost-docs] Boost-wide concept docs
From: Edward Diener (eldiener_at_[hidden])
Date: 2011-02-05 15:50:21

On 2/4/2011 12:12 AM, Steven Watanabe wrote:
> AMDG
>
> On 2/3/2011 5:43 PM, Steven Watanabe wrote:
>> On 2/3/2011 4:32 PM, Edward Diener wrote:
>>> But since it sounds like 'format' is
>>> a feature of the Build system, the feature and all its uses should be
>>> documented somewhere in the Boost Build system documentation.
>>
>> It's only used by boostbook.
>>
>>> Otherwise
>>> how other can one know what the various output format syntax
>>> possibilities are in Boost Build unless they are ?
>>>
>>
>> I'll add docs for the xsltproc, boostbook,
>> quickbook, fo, and doxygen modules, but it
>> will probably take a few days.
>>
>
> Done. It's pretty basic, but I think I got the
> most critical information. If you have the
> documentation toolchain set up, you should
> be able to build it in tools/build/v2/doc.

After getting the latest from the trunk, running 'bjam 
toolset=msvc-10.0' from the 'tools/build/v2/doc' directory produces:

"...updating 2 targets...
xslt-xsltproc.windows 
bin\msvc-10.0\debug\threading-multi\src\standalone.docbook

src/faq.xml:16: validity error : standalone: attribute moreinfo on 
filename defaulted from external subset
       invocation of <filename>bjam</filename>, any given main target can be
                              ^
src/faq.xml:61: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       <code>a.cpp</code>, which differ only in their 
<literal>include</literal>
                                                              ^
src/faq.xml:62: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       property. Since the <literal>include</literal> feature is declared as
                                   ^
src/faq.xml:63: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       <literal>free</literal> Boost.Build does not create a separate build
               ^
src/faq.xml:75: validity error : standalone: attribute inheritnum on 
orderedlist
  defaulted from external subset
     <orderedlist>
                 ^
src/faq.xml:75: validity error : standalone: attribute continuation on 
orderedlist defaulted from external subset
     <orderedlist>
                 ^
src/faq.xml:90: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
           or if you want the <literal>includes</literal> property not 
to affect
                                      ^
src/faq.xml:100: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
           Note that in both of these cases the <literal>include</literal>
                                                        ^
src/faq.xml:126: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
           Note that in both of these cases the <literal>include</literal>
                                                        ^
src/faq.xml:227: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       the <literal>use</literal> relationship one can use the
                   ^
src/faq.xml:228: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       <literal>&lt;use&gt;</literal> feature. For example, both of the 
following

               ^
src/faq.xml:253: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       The <literal>SHELL</literal> builtin rule may be used for this 
purpose:
                   ^
src/faq.xml:305: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       Why are the <literal>dll-path</literal> and 
<literal>hardcode-dll-paths
                           ^
src/faq.xml:305: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       Why are the <literal>dll-path</literal> and 
<literal>hardcode-dll-paths
                                                           ^
src/faq.xml:337: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       the executables. That is done when the <literal>hardcode-dll-paths
                                                      ^
src/faq.xml:338: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       </literal> feature has the <literal>true</literal> value, which 
is the
                                          ^
src/faq.xml:345: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       note --> (The <literal>install</literal> rule explicitly disables the
                             ^
src/faq.xml:346: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       <literal>hardcode-dll-paths</literal> feature for that reason.) 
However,
               ^
src/faq.xml:347: validity error : standalone: attribute moreinfo on 
literal defaulted from external subset
       you can use the <literal>dll-path</literal> feature to add 
explicit paths
                               ^
src/faq.xml:353: validity error : standalone: attribute moreinfo on 
filename def
aulted from external subset
       will allow the application to find libraries placed in the <filename>
                                                                           ^
src/faq.xml:388: validity error : standalone: attribute moreinfo on 
filename defaulted from external subset
       in Boost.Build's <filename>site-config.jam</filename> 
configuration file:
                                 ^
src/faq.xml:396: validity error : standalone: attribute moreinfo on 
filename defaulted from external subset
       Recall that both <filename>site-config.jam</filename> and
                                 ^
src/faq.xml:397: validity error : standalone: attribute moreinfo on 
filename defaulted from external subset
       <filename>user-config.jam</filename> are projects, and everything 
you can
                ^
Cannot find function named 'alias'
Cannot find function named 'using'
Cannot find function named 'using'
Cannot find function named 'using'
Cannot find function named 'using'
Cannot find function named 'glob'
Cannot find function named 'explicit'
Cannot find function named 'project'
Cannot find function named 'project'
Cannot find function named 'alias'
Cannot find function named 'unit-test'
Cannot find function named 'exe'
Cannot find function named 'make
       '
Cannot find function named '
       notfile'
Cannot find function named 'generate
       '
Cannot find function named 'make'
Cannot find function named 'make'
Cannot find function named 'notfile'
Cannot find function named 'notfile'
Cannot find function named 'make'
Cannot find function named 'generate'
Cannot find function named 'generate'
Cannot find function named 'c-pch'
Cannot find class named 'abstract-target'
Cannot find method named 'generate'
Cannot find class named 'property-set'
Cannot find class named 'property-set'
Cannot find class named 'virtual-target'
Cannot find class named 'abstract-target'
Cannot find class named 'project-target'
Cannot find method named 'generate'
Cannot find class named 'main-target'
Cannot find method named 'generate'
Cannot find method named 'generate'
Cannot find class named 'basic-target'
Cannot find method named 'generate'
Cannot find class named 'construct'
Cannot find class named 'project-target'
Cannot find class named 'main-target'
Cannot find class named 'basic-target'
Cannot find class named 'basic-target'
Cannot find class named 'basic-target'
Cannot find class named 'typed-target'
Cannot find class named 'virtual-target'
Cannot find class named 'file-target'
Cannot find class named 'action'
Cannot find class named 'property-set'
Cannot find class named 'action>'
Cannot find class named 'file-target'
Cannot find class named 'typed-target'
Cannot find class named 'typed-target'
Cannot find class named 'generator'
Cannot find class named 'generator'
Cannot find function named 'type.register'
Cannot find function named 'exe'
Cannot find function named 'lib'
xslt-xsltproc-dir.windows html\userman_HTML.manifest
Computing chunks...
Writing userman_HTML.manifest
...updated 2 targets..."

Is this actually building as it should ? When I open the 'index.html' in 
the 'tools/build/v2/doc/html' directory I can not find anything about 
specific pdf formats in the Boost.Build V2 User Manual, but I do find 
the information you added under documentation tools. When I read the 
information there for boostbook it mentions the 'format' option. But 
where do I find out about the option values for the various types of 
option names listed there ?