added option to disable invariant checks and added more build documentation

This commit is contained in:
Arvid Norberg
2008-01-13 06:17:56 +00:00
parent 9304bd747c
commit 795bee4b2c
4 changed files with 52 additions and 1 deletions

View File

@@ -262,6 +262,19 @@ Build features:
| | * ``unicode`` - The unicode version of the win32 |
| | API is used. |
+------------------------+----------------------------------------------------+
| ``invariant-checks`` | This setting only affects debug builds (where |
| | ``NDEBUG`` is not defined). It defaults to ``on``. |
| | |
| | * ``on`` - internal invariant checks are enabled. |
| | * ``off`` - internal invariant checks are |
| | disabled. The resulting executable will run |
| | faster than a regular debug build. |
+------------------------+----------------------------------------------------+
| ``debug-symbols`` | * ``on`` - default for debug builds. This setting |
| | is useful for building release builds with |
| | symbols. |
| | * ``off`` - default for release builds. |
+------------------------+----------------------------------------------------+
The ``variant`` feature is *implicit*, which means you don't need to specify
the name of the feature, just the value.
@@ -527,6 +540,13 @@ defines you can use to control the build.
| ``TORRENT_DISABLE_RESOLVE_COUNTRIES`` | Defining this will disable the ability to |
| | resolve countries of origin for peer IPs. |
+---------------------------------------+-------------------------------------------------+
| ``TORRENT_DISABLE_INVARIANT_CHECKS`` | This will disable internal invariant checks in |
| | libtorrent. The invariant checks can sometime |
| | be quite expensive, they typically don't scale |
| | very well. This option can be used to still |
| | build in debug mode, with asserts enabled, but |
| | make the resulting executable faster. |
+---------------------------------------+-------------------------------------------------+
If you experience that libtorrent uses unreasonable amounts of cpu, it will