From 6b3ac0be2aa29ccb324fd48bb25608bbe148a209 Mon Sep 17 00:00:00 2001
From: Arvid Norberg <arvid@libtorrent.org>
Date: Mon, 7 Apr 2008 00:15:36 +0000
Subject: [PATCH] documentation fixes

---
 docs/manual.html | 28 ++++------------------------
 docs/manual.rst  |  7 ++++---
 2 files changed, 8 insertions(+), 27 deletions(-)

diff --git a/docs/manual.html b/docs/manual.html
index 77c4cc444..298398c27 100644
--- a/docs/manual.html
+++ b/docs/manual.html
@@ -218,7 +218,8 @@ the <tt class="docutils literal"><span class="pre">session</span></tt>, it conta
 <ul>
 <li><p class="first">construct a session</p>
 </li>
-<li><p class="first">start DHT, LSD, UPnP, NAT-PMP etc (see <a href="#id176"><span class="problematic" id="id177">start_dht_</span></a>, <a href="#id178"><span class="problematic" id="id179">start_lsd_</span></a>, <a href="#id180"><span class="problematic" id="id181">start_upnp_</span></a> and <a href="#id182"><span class="problematic" id="id183">start_natpmp_</span></a>)</p>
+<li><p class="first">start DHT, LSD, UPnP, NAT-PMP etc (see <a class="reference internal" href="#start-dht-stop-dht-set-dht-settings-dht-state">start_dht() stop_dht() set_dht_settings() dht_state()</a>
+<a class="reference internal" href="#start-lsd-stop-lsd">start_lsd() stop_lsd()</a>, <a class="reference internal" href="#start-upnp-stop-upnp">start_upnp() stop_upnp()</a> and <a class="reference internal" href="#start-natpmp-stop-natpmp">start_natpmp() stop_natpmp()</a>)</p>
 </li>
 <li><p class="first">parse .torrent-files and add them to the session (see <a class="reference internal" href="#bdecode-bencode">bdecode() bencode()</a> and <a class="reference internal" href="#add-torrent">add_torrent()</a>)</p>
 </li>
@@ -1019,7 +1020,7 @@ port are attempted to be forwarded on local UPnP router devices.</p>
 <p>The upnp object returned by <tt class="docutils literal"><span class="pre">start_upnp()</span></tt> can be used to add and remove
 arbitrary port mappings. Mapping status is returned through the
 <a class="reference internal" href="#portmap-alert">portmap_alert</a> and the <a class="reference internal" href="#portmap-error-alert">portmap_error_alert</a>. The object will be valid until
-<a href="#id184"><span class="problematic" id="id185">stop_upnp_</span></a> is called. See <a class="reference internal" href="#upnp-and-nat-pmp">UPnP and NAT-PMP</a>.</p>
+<tt class="docutils literal"><span class="pre">stop_upnp()</span></tt> is called. See <a class="reference internal" href="#upnp-and-nat-pmp">UPnP and NAT-PMP</a>.</p>
 <p>It is off by default.</p>
 </div>
 <div class="section" id="start-natpmp-stop-natpmp">
@@ -1035,7 +1036,7 @@ port are attempted to be forwarded on the router through NAT-PMP.</p>
 <p>The natpmp object returned by <tt class="docutils literal"><span class="pre">start_natpmp()</span></tt> can be used to add and remove
 arbitrary port mappings. Mapping status is returned through the
 <a class="reference internal" href="#portmap-alert">portmap_alert</a> and the <a class="reference internal" href="#portmap-error-alert">portmap_error_alert</a>. The object will be valid until
-<a href="#id186"><span class="problematic" id="id187">stop_upnp_</span></a> is called. See <a class="reference internal" href="#upnp-and-nat-pmp">UPnP and NAT-PMP</a>.</p>
+<tt class="docutils literal"><span class="pre">stop_natpmp()</span></tt> is called. See <a class="reference internal" href="#upnp-and-nat-pmp">UPnP and NAT-PMP</a>.</p>
 <p>It is off by default.</p>
 </div>
 </div>
@@ -4546,27 +4547,6 @@ scripts.</p>
 <p>Project is hosted by sourceforge.</p>
 <p><a class="reference external" href="http://sourceforge.net"><img alt="sf_logo" src="http://sourceforge.net/sflogo.php?group_id=7994" /></a></p>
 </div>
-<div class="system-messages section">
-<h1>Docutils System Messages</h1>
-<div class="system-message" id="id176">
-<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id177">backlink</a></em></p>
-Unknown target name: &quot;start_dht&quot;.</div>
-<div class="system-message" id="id178">
-<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id179">backlink</a></em></p>
-Unknown target name: &quot;start_lsd&quot;.</div>
-<div class="system-message" id="id180">
-<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id181">backlink</a></em></p>
-Unknown target name: &quot;start_upnp&quot;.</div>
-<div class="system-message" id="id182">
-<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id183">backlink</a></em></p>
-Unknown target name: &quot;start_natpmp&quot;.</div>
-<div class="system-message" id="id184">
-<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 893); <em><a href="#id185">backlink</a></em></p>
-Unknown target name: &quot;stop_upnp&quot;.</div>
-<div class="system-message" id="id186">
-<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 911); <em><a href="#id187">backlink</a></em></p>
-Unknown target name: &quot;stop_upnp&quot;.</div>
-</div>
 </div>
 </body>
 </html>
diff --git a/docs/manual.rst b/docs/manual.rst
index 87541471c..2f1daab57 100644
--- a/docs/manual.rst
+++ b/docs/manual.rst
@@ -18,7 +18,8 @@ the ``session``, it contains the main loop that serves all torrents.
 The basic usage is as follows:
 
 * construct a session
-* start DHT, LSD, UPnP, NAT-PMP etc (see start_dht_, start_lsd_, start_upnp_ and start_natpmp_)
+* start DHT, LSD, UPnP, NAT-PMP etc (see `start_dht() stop_dht() set_dht_settings() dht_state()`_
+  `start_lsd() stop_lsd()`_, `start_upnp() stop_upnp()`_ and `start_natpmp() stop_natpmp()`_)
 * parse .torrent-files and add them to the session (see `bdecode() bencode()`_ and `add_torrent()`_)
 * main loop (see session_)
 
@@ -893,7 +894,7 @@ port are attempted to be forwarded on local UPnP router devices.
 The upnp object returned by ``start_upnp()`` can be used to add and remove
 arbitrary port mappings. Mapping status is returned through the
 portmap_alert_ and the portmap_error_alert_. The object will be valid until
-stop_upnp_ is called. See `UPnP and NAT-PMP`_.
+``stop_upnp()`` is called. See `UPnP and NAT-PMP`_.
 
 It is off by default.
 
@@ -911,7 +912,7 @@ port are attempted to be forwarded on the router through NAT-PMP.
 The natpmp object returned by ``start_natpmp()`` can be used to add and remove
 arbitrary port mappings. Mapping status is returned through the
 portmap_alert_ and the portmap_error_alert_. The object will be valid until
-stop_upnp_ is called. See `UPnP and NAT-PMP`_.
+``stop_natpmp()`` is called. See `UPnP and NAT-PMP`_.
 
 It is off by default.