[Boost-bugs] [Boost C++ Libraries] #2232: Documentation build needs to detect missing prerequisites

Subject: [Boost-bugs] [Boost C++ Libraries] #2232: Documentation build needs to detect missing prerequisites
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2008-08-20 11:04:05

#2232: Documentation build needs to detect missing prerequisites
------------------------------+---------------------------------------------
 Reporter:  bemandawes        |       Owner:         
     Type:  Feature Requests  |      Status:  new    
Milestone:  Boost 1.36.0      |   Component:  None   
  Version:  Boost 1.36.0      |    Severity:  Problem
 Keywords:                    |  
------------------------------+---------------------------------------------
 Building documentation requires a lengthy tool chain to work correctly.

 The following tools have to be installed:

      libxml2, libxslt, doxygen, docbook-xml42, docbook-xsl, tetex (?),
 ghostscript

 user-config.jam needs to supply usings for:

      xsltproc,
      boostbook with docbook-xsl and docbook/4.2,
      doxygen,
      quickbook

 Experience has shown that (1) even very experienced Boost developers can
 have missing tool chain items, and (2) missing tool chain items are very
 difficult to diagnose and repair because the current bjam setup does not
 issue meaningful error messages, produces partial documentation, and gives
 the appearance of working.

 The requested fix is twofold:

 *  Specific error messages should be issued if the tool chain is not
 complete. The messages should distinguish between tools not being
 installed and user-config.jam not having all the required entires. The
 error messages should name the specific missing tool or missing user-
 config.jam entry.

 *  If one of the above errors is detected, the process should stop at that
 point. Currently partial documentation is built, and that can be very
 misleading and time-consuming. If the tool chain is wrong, nothing at all
 should be built.

-- 
Ticket URL: <http://svn.boost.org/trac/boost/ticket/2232>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.