wornvirtue
/
premiere-libtorrent
forked from premiere/premiere-libtorrent
1
0
Fork 0
Code Pull Requests Activity

added documentation for new create_torrent constructor

This commit is contained in:
Arvid Norberg 2008-09-24 21:55:31 +00:00
parent 61af2370f3
commit 19b6525932
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/make_torrent.rst
View File

@ -150,6 +150,7 @@ The ``create_torrent`` class has the following synopsis::
{
create_torrent(file_storage& fs, int piece_size);
create_torrent(file_storage& fs);
create_torrent(torrent_info const& ti);
entry generate() const;
@ -174,10 +175,18 @@ create_torrent()
create_torrent(file_storage& fs, int piece_size);
create_torrent(file_storage& fs);
create_torrent(torrent_info const& ti);
The contrstructor that does not take a piece_size will calculate
a piece size such that the torrent file is roughly 40 kB.
The overlad that takes a ``torrent_info`` object will make a verbatim
copy of its info dictionary (to preserve the info-hash). The copy of
the info dictionary will be used by ``generate()``. This means
that none of the member functions of create_torrent that affects
the content of the info dictionary (such as ``set_hash()``), will not
have any affect.
generate()
----------