Boost C++ Libraries: Ticket #4872: Docs don't build corectly https://svn.boost.org/trac10/ticket/4872 <p> 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. </p> <p> On Linux, building from either libs/signals2/doc or doc/pdf the snippet_extractor is invoked with: </p> <pre class="wiki">/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 </pre><p> Which places the xml files in the wrong place. </p> <p> On Windows the command line is even more bizare: </p> <pre class="wiki">..\..\..\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 </pre><p> Either way the net result is: </p> <pre class="wiki">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" </pre><p> and the result is broken documentation. </p> en-us Boost C++ Libraries /htdocs/site/boost.png https://svn.boost.org/trac10/ticket/4872 Trac 1.4.3 Frank Mori Hess Tue, 23 Nov 2010 04:07:45 GMT <link>https://svn.boost.org/trac10/ticket/4872#comment:1 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/4872#comment:1</guid> <description> <p> (In <a class="changeset" href="https://svn.boost.org/trac10/changeset/66694" title="Patch from John Maddock: ...">[66694]</a>) Patch from John Maddock: <a class="ext-link" href="http://lists.boost.org/Archives/boost/2010/11/173288.php"><span class="icon">​</span>http://lists.boost.org/Archives/boost/2010/11/173288.php</a> </p> <p> Refs <a class="closed ticket" href="https://svn.boost.org/trac10/ticket/4872" title="#4872: Bugs: Docs don't build corectly (closed: fixed)">#4872</a>. </p> </description> <category>Ticket</category> </item> <item> <dc:creator>Frank Mori Hess</dc:creator> <pubDate>Tue, 23 Nov 2010 04:19:27 GMT</pubDate> <title>owner, component, severity changed https://svn.boost.org/trac10/ticket/4872#comment:2 https://svn.boost.org/trac10/ticket/4872#comment:2 <ul> <li><strong>owner</strong> changed from <span class="trac-author">Frank Mori Hess</span> to <span class="trac-author">Vladimir Prus</span> </li> <li><strong>component</strong> <span class="trac-field-old">signals2</span> → <span class="trac-field-new">build</span> </li> <li><strong>severity</strong> <span class="trac-field-old">Showstopper</span> → <span class="trac-field-new">Problem</span> </li> </ul> <p> I applied the patch posted by John Maddock which works around the bug for the signals2 doc: <a class="ext-link" href="http://lists.boost.org/Archives/boost/2010/11/173288.php"><span class="icon">​</span>http://lists.boost.org/Archives/boost/2010/11/173288.php</a>. However, according to the report the bug is in Boost.Build when compiling on msvc in debug mode. In the following line from libs/signals2/doc/snippet-extractor.jam: </p> <blockquote> <p> $(EXTRACTOR-COMMAND) "$(&lt;:D)" $(&gt;) </p> </blockquote> <p> the ":D" doesn't result in a directory as it should on msvc in debug mode. </p> Ticket Vladimir Prus Tue, 23 Nov 2010 06:55:42 GMT <link>https://svn.boost.org/trac10/ticket/4872#comment:3 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/4872#comment:3</guid> <description> <p> It seems to me that :D modifier is working as expected, and the problem is that $(EXTRACTOR-COMMAND) expands to two paths -- path to exe and path to pdb. Does $(EXTRACTOR-COMMAND<a class="changeset" href="https://svn.boost.org/trac10/changeset/1" title="Import core sources for SVNmanger 0.38 ">[1]</a>) fix the problem? </p> </description> <category>Ticket</category> </item> <item> <dc:creator>Frank Mori Hess</dc:creator> <pubDate>Tue, 23 Nov 2010 15:36:47 GMT</pubDate> <title/> <link>https://svn.boost.org/trac10/ticket/4872#comment:4 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/4872#comment:4</guid> <description> <p> I changed EXTRACTOR_COMMAND to EXTRACTOR_COMMAND<a class="changeset" href="https://svn.boost.org/trac10/changeset/1" title="Import core sources for SVNmanger 0.38 ">[1]</a> locally and verified that signals2 doc build still works correctly under Linux after the change. I don't have msvc to verify it resolves the msvc/debug problem there though. Is EXTRACTOR-COMMAND<a class="changeset" href="https://svn.boost.org/trac10/changeset/1" title="Import core sources for SVNmanger 0.38 ">[1]</a> what I was supposed to be doing (that is, should I commit the change to svn)? </p> </description> <category>Ticket</category> </item> <item> <dc:creator>anonymous</dc:creator> <pubDate>Tue, 23 Nov 2010 16:54:41 GMT</pubDate> <title/> <link>https://svn.boost.org/trac10/ticket/4872#comment:5 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/4872#comment:5</guid> <description> <p> I just tested that with msvc-10 on Windows, and yes it's working there too: </p> <pre class="wiki">actions extract-snippets bind EXTRACTOR-COMMAND { $(EXTRACTOR-COMMAND[1]) "$(&lt;:D)" $(&gt;) } </pre><p> HTH, John. </p> </description> <category>Ticket</category> </item> <item> <dc:creator>Steven Watanabe</dc:creator> <pubDate>Wed, 06 Apr 2011 23:52:27 GMT</pubDate> <title/> <link>https://svn.boost.org/trac10/ticket/4872#comment:6 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/4872#comment:6</guid> <description> <p> (In <a class="changeset" href="https://svn.boost.org/trac10/changeset/71058" title="Make sure that the command works even in debug mode. Refs #4872.">[71058]</a>) Make sure that the command works even in debug mode. Refs <a class="closed ticket" href="https://svn.boost.org/trac10/ticket/4872" title="#4872: Bugs: Docs don't build corectly (closed: fixed)">#4872</a>. </p> </description> <category>Ticket</category> </item> <item> <dc:creator>Steven Watanabe</dc:creator> <pubDate>Wed, 06 Apr 2011 23:56:24 GMT</pubDate> <title>status changed; resolution set https://svn.boost.org/trac10/ticket/4872#comment:7 https://svn.boost.org/trac10/ticket/4872#comment:7 <ul> <li><strong>status</strong> <span class="trac-field-old">new</span> → <span class="trac-field-new">closed</span> </li> <li><strong>resolution</strong> → <span class="trac-field-new">fixed</span> </li> </ul> <p> This is a pretty simple thing, so I checked it with msvc and gcc using both debug and release and committed it. (I temporarily reverted John's other patch to test debug). </p> Ticket