Skip to content

Commit 2851325

Browse files
committed
Doc and build fixes by Dave Abrahams.
[SVN r38154]
1 parent bd606e5 commit 2851325

File tree

3 files changed

+11
-29
lines changed

3 files changed

+11
-29
lines changed

doc/building.html

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ <h1><a class="toc-backref" href="#id26">2&nbsp;&nbsp;&nbsp;Background</a></h1>
7575
modules or the executable containing <tt class="docutils literal"><span class="pre">main()</span></tt>.</p>
7676
</div>
7777
<div class="section" id="no-install-quickstart">
78-
<h1><a class="toc-backref" href="#id27">3&nbsp;&nbsp;&nbsp;No-Install Quickstart</a></h1>
78+
<span id="quickstart"></span><h1><a class="toc-backref" href="#id27">3&nbsp;&nbsp;&nbsp;No-Install Quickstart</a></h1>
7979
<p>There is no need to “install Boost” in order to get started using
8080
Boost.Python. These instructions use <a class="reference external" href="../../../tools/build/index.html">Boost.Build</a> projects,
8181
which will build those binaries as soon as they're needed. Your
@@ -273,14 +273,6 @@ <h1><a class="toc-backref" href="#id32">4&nbsp;&nbsp;&nbsp;Installing Boost.Pyth
273273
argument to <tt class="docutils literal"><span class="pre">bjam</span></tt> (or the <tt class="docutils literal"><span class="pre">--with-libraries=python</span></tt> argument
274274
to <tt class="docutils literal"><span class="pre">configure</span></tt>), so only the Boost.Python binary will be built,
275275
rather than all the Boost binaries.</p>
276-
<div class="admonition-windows-users-no-auto-link-support admonition">
277-
<p class="first admonition-title">Windows Users: No Auto-Link Support</p>
278-
<p class="last">Boost.Python does not yet support the <a class="reference external" href="../../../more/getting_started/windows.html#link-your-program-to-a-boost-library">auto-link</a> feature, so if
279-
you're not using the <a class="reference internal" href="#no-install-quickstart">quickstart</a> method, you'll have to pay
280-
attention to the names of generated libraries and add extra link
281-
arguments not shown in the <a class="reference external" href="../../../more/getting_started/index.html">Getting Started Guide</a> to select the
282-
right library.</p>
283-
</div>
284276
</div>
285277
<div class="section" id="configuring-boost-build">
286278
<h1><a class="toc-backref" href="#id33">5&nbsp;&nbsp;&nbsp;Configuring Boost.Build</a></h1>
@@ -309,7 +301,7 @@ <h1><a class="toc-backref" href="#id33">5&nbsp;&nbsp;&nbsp;Configuring Boost.Bui
309301
</pre>
310302
<p>which automatically looks for Python in the most likely places.
311303
However, that only happens when using the Boost.Python project file
312-
(e.g. when referred to by another project as in the <a class="reference internal" href="#no-install-quickstart">quickstart</a>
304+
(e.g. when referred to by another project as in the <a class="reference internal" href="#quickstart">quickstart</a>
313305
method). If instead you are linking against separately-compiled
314306
Boost.Python binaries, you should set up a <tt class="docutils literal"><span class="pre">user-config.jam</span></tt> file
315307
with at least the minimal incantation above.</p>
@@ -570,9 +562,6 @@ <h1><a class="toc-backref" href="#id42">10&nbsp;&nbsp;&nbsp;Notes for MinGW (and
570562
<li><a class="reference external" href="../../../more/getting_started/windows.html#library-naming">on Windows</a></li>
571563
<li><a class="reference external" href="../../../more/getting_started/unix-variants.html#library-naming">on Unix variants</a></li>
572564
</ul>
573-
<p class="last">Be sure to read this section even if your compiler supports
574-
auto-linking, as Boost.Python does not yet take advantage of
575-
that feature.</p>
576565
</td></tr>
577566
</tbody>
578567
</table>
@@ -639,7 +628,7 @@ <h1><a class="toc-backref" href="#id42">10&nbsp;&nbsp;&nbsp;Notes for MinGW (and
639628
<div class="footer">
640629
<hr class="footer" />
641630
<a class="reference external" href="./building.rst">View document source</a>.
642-
Generated on: 2007-05-07 18:58 UTC.
631+
Generated on: 2007-07-02 13:46 UTC.
643632
Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
644633

645634
</div>

doc/building.rst

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ dynamically-loaded libraries with a single entry point, which means
6565
you can change them without rebuilding either the other extension
6666
modules or the executable containing ``main()``.
6767

68+
.. _quickstart:
69+
6870
No-Install Quickstart
6971
=====================
7072

@@ -326,17 +328,6 @@ argument to ``bjam`` (or the ``--with-libraries=python`` argument
326328
to ``configure``), so only the Boost.Python binary will be built,
327329
rather than all the Boost binaries.
328330

329-
.. Admonition:: Windows Users: No Auto-Link Support
330-
331-
Boost.Python does not yet support the `auto-link`_ feature, so if
332-
you're not using the quickstart_ method, you'll have to pay
333-
attention to the names of generated libraries and add extra link
334-
arguments not shown in the `Getting Started Guide`_ to select the
335-
right library.
336-
337-
.. _auto-link: ../../../more/getting_started/windows.html#link-your-program-to-a-boost-library
338-
339-
.. _quickstart: `no-install quickstart`_
340331

341332
Configuring Boost.Build
342333
=======================
@@ -652,10 +643,6 @@ __ http://www.python.org/doc/current/inst/index.html
652643
__ ../../../more/getting_started/windows.html#library-naming
653644
__ ../../../more/getting_started/unix-variants.html#library-naming
654645
655-
Be sure to read this section even if your compiler supports
656-
auto-linking, as Boost.Python does not yet take advantage of
657-
that feature.
658-
659646
.. [#toolset-specific] Because of the way most \*nix platforms
660647
share symbols among dynamically-loaded objects, I'm not certain
661648
that extension modules built with different compiler toolsets

example/quickstart/Jamroot

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,9 @@ testing.run embedding
3535
: # requirements
3636
: test_embed ; # name of test
3737

38+
# Create a "test" target that runs all the tests
39+
alias test : test_ext test_embed ;
40+
41+
# make sure the tests don't run by default
42+
explicit test_ext test_embed test ;
43+

0 commit comments

Comments
 (0)