added docs regarding NDEBUG

This commit is contained in:
Arvid Norberg 2008-01-12 18:19:18 +00:00
parent 7f56486cf0
commit fd466d891b
2 changed files with 14 additions and 4 deletions

View File

@ -458,8 +458,13 @@ defines you can use to control the build.</p>
<tr><td><tt class="docutils literal"><span class="pre">NDEBUG</span></tt></td> <tr><td><tt class="docutils literal"><span class="pre">NDEBUG</span></tt></td>
<td>If you define this macro, all asserts, <td>If you define this macro, all asserts,
invariant checks and general debug code will be invariant checks and general debug code will be
removed. This option takes precedence over removed. Since there is quite a lot of code in
other debug settings.</td> in header files in libtorrent, it may be
important to define the symbol consistently
across compilation units, including the clients
files. Potential problems is different
compilation units having different views of
structs and class layouts and sizes.</td>
</tr> </tr>
<tr><td><tt class="docutils literal"><span class="pre">TORRENT_LOGGING</span></tt></td> <tr><td><tt class="docutils literal"><span class="pre">TORRENT_LOGGING</span></tt></td>
<td>This macro will enable logging of the session <td>This macro will enable logging of the session

View File

@ -442,8 +442,13 @@ defines you can use to control the build.
+=================================+=================================================+ +=================================+=================================================+
| ``NDEBUG`` | If you define this macro, all asserts, | | ``NDEBUG`` | If you define this macro, all asserts, |
| | invariant checks and general debug code will be | | | invariant checks and general debug code will be |
| | removed. This option takes precedence over | | | removed. Since there is quite a lot of code in |
| | other debug settings. | | | in header files in libtorrent, it may be |
| | important to define the symbol consistently |
| | across compilation units, including the clients |
| | files. Potential problems is different |
| | compilation units having different views of |
| | structs and class layouts and sizes. |
+---------------------------------+-------------------------------------------------+ +---------------------------------+-------------------------------------------------+
| ``TORRENT_LOGGING`` | This macro will enable logging of the session | | ``TORRENT_LOGGING`` | This macro will enable logging of the session |
| | events, such as tracker announces and incoming | | | events, such as tracker announces and incoming |