2010-02-18 21:01:23 +01:00
|
|
|
=================
|
|
|
|
|
libtorrent manual
|
|
|
|
|
=================
|
|
|
|
|
|
2018-10-01 11:34:06 +02:00
|
|
|
.. include:: header.rst
|
2010-02-18 21:01:23 +01:00
|
|
|
|
|
|
|
|
.. contents:: Table of contents
|
|
|
|
|
:depth: 2
|
|
|
|
|
:backlinks: none
|
|
|
|
|
|
|
|
|
|
contributing to libtorrent
|
|
|
|
|
==========================
|
|
|
|
|
|
|
|
|
|
There are several ways to contribute to libtorrent at various levels. Any help is
|
|
|
|
|
much appreciated. If you're interested in something libtorrent related that's not
|
2014-10-14 04:06:20 +02:00
|
|
|
enumerated on this page, please contact arvid@libtorrent.org or the `mailing list`_.
|
2010-02-18 21:01:23 +01:00
|
|
|
|
2018-04-03 11:32:41 +02:00
|
|
|
.. _`mailing list`: https://lists.sourceforge.net/lists/listinfo/libtorrent-discuss
|
2010-02-18 21:01:23 +01:00
|
|
|
|
|
|
|
|
1. Testing
|
|
|
|
|
This is not just limited to finding bugs and ways to reproduce crashes, but also
|
|
|
|
|
sub-optimal behavior is certain scenarios and finding ways to reproduce those. Please
|
2015-10-11 23:09:30 +02:00
|
|
|
report any issue to the bug tracker at `github`_.
|
2010-02-18 21:01:23 +01:00
|
|
|
|
2010-02-19 05:20:11 +01:00
|
|
|
New features that need testing are streaming (``set_piece_deadline()``), the different
|
|
|
|
|
choking algorithms (especially the new BitTyrant choker), the disk cache options (such
|
|
|
|
|
as ``explicit_cache``).
|
|
|
|
|
|
2015-10-11 23:09:30 +02:00
|
|
|
.. _`github`: https://github.com/arvidn/libtorrent/issues
|
2010-02-18 21:01:23 +01:00
|
|
|
|
|
|
|
|
2. Documentation
|
|
|
|
|
Finding typos or outdated sections in the documentation. Contributing documentation
|
|
|
|
|
based on your own experience and experimentation with the library or with BitTorrent
|
|
|
|
|
in general. Non-reference documentation is very much welcome as well, higher level
|
|
|
|
|
descriptions on how to configure libtorrent for various situations for instance.
|
2016-02-20 22:38:56 +01:00
|
|
|
The reference documentation for libtorrent is generated from the header files.
|
2019-12-16 13:52:31 +01:00
|
|
|
|
|
|
|
|
Each heading in the online documentation has a short-cut link to file a new issue
|
|
|
|
|
against the documentation.
|
|
|
|
|
|
|
|
|
|
For updates, please submit a `pull request`_. All documentation is in
|
|
|
|
|
restructured text (rst_). All documentation is spell checked with hunspell
|
|
|
|
|
which can be invoked via ``make spell-check`` in the docs directory. If
|
|
|
|
|
words are missing, please add them to ``docs/hunspell/libtorrent.dic``
|
2010-02-18 21:01:23 +01:00
|
|
|
|
|
|
|
|
3. Code
|
|
|
|
|
Contributing code for new features or bug-fixes is highly welcome. If you're interested
|
|
|
|
|
in adding a feature but not sure where to start, please contact the `mailing list`_ or
|
2018-10-19 19:56:07 +02:00
|
|
|
``#libtorrent`` @ ``irc.freenode.net``. For proposed fixes or updates, please
|
2016-02-20 22:38:56 +01:00
|
|
|
submit a `pull request`_.
|
2010-02-18 21:01:23 +01:00
|
|
|
|
2010-02-19 05:20:11 +01:00
|
|
|
New features might be better support for integrating with other services, new choking
|
|
|
|
|
algorithms, seeding policies, ports to new platforms etc.
|
|
|
|
|
|
2013-01-21 20:13:24 +01:00
|
|
|
For an overview of the internals of libtorrent, see the hacking_ page.
|
|
|
|
|
|
2017-09-25 15:30:10 +02:00
|
|
|
For outstanding things to do, see the `todo list`_ or the `sonarqube analysis`_ of master.
|
2013-01-21 20:13:24 +01:00
|
|
|
|
|
|
|
|
.. _hacking: hacking.html
|
2016-02-20 22:38:56 +01:00
|
|
|
.. _`pull request`: https://github.com/arvidn/libtorrent
|
2013-01-21 20:13:24 +01:00
|
|
|
.. _`todo list`: todo.html
|
2017-09-25 15:30:10 +02:00
|
|
|
.. _`sonarqube analysis`: https://sonarcloud.io/dashboard?id=libtorrent
|
2019-12-16 13:52:31 +01:00
|
|
|
.. _rst: https://docutils.sourceforge.io/rst.html
|
2017-09-25 15:30:10 +02:00
|
|
|
|
