From 86fcad4556df66c13066e64125bedbb5c4659a6a Mon Sep 17 00:00:00 2001
From: Arvid Norberg <arvid@libtorrent.org>
Date: Sun, 6 Jan 2008 21:39:56 +0000
Subject: [PATCH] documented upnp-logging option

---
 docs/building.html | 13 +++++++++++++
 docs/building.rst  |  8 ++++++++
 2 files changed, 21 insertions(+)

diff --git a/docs/building.html b/docs/building.html
index 7926bf451..73d793658 100644
--- a/docs/building.html
+++ b/docs/building.html
@@ -215,6 +215,14 @@ with the libtorrent package.</li>
 </ul>
 </td>
 </tr>
+<tr><td><tt class="docutils literal"><span class="pre">upnp-logging</span></tt></td>
+<td><ul class="first last simple">
+<li><tt class="docutils literal"><span class="pre">off</span></tt> - default. Does not log UPnP traffic.</li>
+<li><tt class="docutils literal"><span class="pre">on</span></tt> - creates &quot;upnp.log&quot; with the messages
+sent to and received from UPnP devices.</li>
+</ul>
+</td>
+</tr>
 <tr><td><tt class="docutils literal"><span class="pre">openssl</span></tt></td>
 <td><ul class="first last simple">
 <li><tt class="docutils literal"><span class="pre">pe</span></tt> - turns on support for encrypted
@@ -456,6 +464,11 @@ the session log.</td>
 checks in the storage, including logging of
 piece sorting.</td>
 </tr>
+<tr><td><tt class="docutils literal"><span class="pre">TORRENT_UPNP_LOGGING</span></tt></td>
+<td>Generates a &quot;upnp.log&quot; file with the UPnP
+traffic. This is very useful when debugging
+support for various UPnP routers.</td>
+</tr>
 <tr><td><tt class="docutils literal"><span class="pre">UNICODE</span></tt></td>
 <td>If building on windows this will make sure the
 UTF-8 strings in pathnames are converted into
diff --git a/docs/building.rst b/docs/building.rst
index 44dd86710..ecb7ba82d 100644
--- a/docs/building.rst
+++ b/docs/building.rst
@@ -213,6 +213,10 @@ Build features:
 |                        | * ``shipped`` - links against the zlib bundled     |
 |                        |   with the libtorrent package.                     |
 +------------------------+----------------------------------------------------+
+| ``upnp-logging``       | * ``off`` - default. Does not log UPnP traffic.    |
+|                        | * ``on`` - creates "upnp.log" with the messages    |
+|                        |   sent to and received from UPnP devices.          |
++------------------------+----------------------------------------------------+
 | ``openssl``            | * ``pe`` - turns on support for encrypted          |
 |                        |   connections. requires openssl (libcrypto)        |
 |                        | * ``sha-1`` - openssl will be used instead of the  |
@@ -445,6 +449,10 @@ defines you can use to control the build.
 |                                 | checks in the storage, including logging of     |
 |                                 | piece sorting.                                  |
 +---------------------------------+-------------------------------------------------+
+| ``TORRENT_UPNP_LOGGING``        | Generates a "upnp.log" file with the UPnP       |
+|                                 | traffic. This is very useful when debugging     |
+|                                 | support for various UPnP routers.               |
++---------------------------------+-------------------------------------------------+
 | ``UNICODE``                     | If building on windows this will make sure the  |
 |                                 | UTF-8 strings in pathnames are converted into   |
 |                                 | UTF-16 before they are passed to the file       |