[Boost-bugs] [Boost C++ Libraries] #4872: Docs don't build corectly

Subject: [Boost-bugs] [Boost C++ Libraries] #4872: Docs don't build corectly
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-11-20 09:43:40

#4872: Docs don't build corectly
--------------------------+-------------------------------------------------
 Reporter:  johnmaddock   |       Owner:  fmhess     
     Type:  Bugs          |      Status:  new        
Milestone:  Boost-1.46.0  |   Component:  signals2   
  Version:  Boost 1.45.0  |    Severity:  Showstopper
 Keywords:                |  
--------------------------+-------------------------------------------------
 The signals2 docs don't build correctly when attempting to build the PDF
 documentation.  The problem is the snippet_extractor program which gets
 invoked with the wrong destination path.  In addition, the Jamfile should
 have a "using boostbook ;" statement at the start otherwise the doc build
 rules aren't found.

 On Linux, building from either libs/signals2/doc or doc/pdf the
 snippet_extractor is invoked with:

 {{{
 /home/john/bin/boost/bin.v2/libs/signals2/doc/gcc-4.4.3/debug/snippet_extractor
 "/home/john/bin/boost/bin.v2/libs/signals2/doc/gcc-4.4.3/debug"
 ../example/custom_combiners.cpp ../example/disconnect_and_block.cpp
 ../example/doc_view.cpp ../example/doc_view_acm.cpp
 ../example/doc_view_acm_deconstruct.cpp ../example/extended_slot.cpp
 ../example/hello_world_multi_slot.cpp ../example/hello_world_slot.cpp
 ../example/ordering_slots.cpp ../example/passing_slots.cpp
 ../example/postconstructor_ex1.cpp ../example/postconstructor_ex2.cpp
 ../example/predestructor_example.cpp ../example/signal_return_value.cpp
 ../example/slot_arguments.cpp
 }}}

 Which places the xml files in the wrong place.

 On Windows the command line is even more bizare:

 {{{
 ..\..\..\bin.v2\libs\signals2\doc\msvc-10.0\debug\threading-
 multi\snippet_extractor.exe
 ..\..\..\bin.v2\libs\signals2\doc\msvc-10.0\debug\threading-
 multi\snippet_extractor.pdb
 "..\..\..\bin.v2\libs\signals2\doc\msvc-10.0\debug\threading
 -multi" ..\example\custom_combiners.cpp
 ..\example\disconnect_and_block.cpp ..\example\doc_view.cpp
 ..\example\doc_view_acm.cpp ..\example\doc_view_acm_deconstruct.cpp
 ..\example\extended_slot.cpp ..\example\hello_world_multi_slot.cpp
 ..\example\hello_world_slot.cpp ..\example\ordering_slots.cpp
 ..\example\passing_slots.cpp ..\example\postconstructor_ex1.cpp
 ..\example\postconstructor_ex2.cpp ..\example\predestructor_example.cpp
 ..\example\signal_return_value.cpp ..\example\slot_arguments.cpp
 }}}

 Either way the net result is:

 {{{
 warning: failed to load external entity "hello_world_def_code_snippet.xml"
 tutorial.xml:50: element include: XInclude error : could not load
 hello_world_def_code_snippet.xml, and no fallback was found
 warning: failed to load external entity
 "hello_world_single_code_snippet.xml"
 tutorial.xml:52: element include: XInclude error : could not load
 hello_world_single_code_snippet.xml, and no fallback was found
 warning: failed to load external entity "hello_def_code_snippet.xml"
 tutorial.xml:63: element include: XInclude error : could not load
 hello_def_code_snippet.xml, and no fallback was found
 warning: failed to load external entity "world_def_code_snippet.xml"
 tutorial.xml:67: element include: XInclude error : could not load
 world_def_code_snippet.xml, and no fallback was found
 warning: failed to load external entity
 "hello_world_multi_code_snippet.xml"
 tutorial.xml:74: element include: XInclude error : could not load
 hello_world_multi_code_snippet.xml, and no fallback was found
 warning: failed to load external entity
 "hello_world_ordered_code_snippet.xml"
 tutorial.xml:94: element include: XInclude error : could not load
 hello_world_ordered_code_snippet.xml, and no fallback was found
 warning: failed to load external entity
 "good_morning_def_code_snippet.xml"
 tutorial.xml:119: element include: XInclude error : could not load
 good_morning_def_code_snippet.xml, and no fallback was found
 warning: failed to load external entity
 "hello_world_ordered_invoke_code_snippet.xml"
 }}}

 and the result is broken documentation.

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