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

added documentation to explain that remap_files can be used to rename the base name of a torrent

This commit is contained in:
Arvid Norberg 2010-03-22 17:20:41 +00:00
parent 8724b89499
commit 241b72aabe
2 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/manual.html
View File

@ -1728,7 +1728,7 @@ which the trackers are to be tried. For more information see <a class="reference
<h2>files() orig_files()</h2>
<blockquote>
<pre class="literal-block">
file_storage const&amp; file() const;
file_storage const&amp; files() const;
file_storage const&amp; orig_files() const;
</pre>
</blockquote>
@ -1766,6 +1766,9 @@ void rename_file(int index, std::wstring const&amp; new_filename);
<p>Renames a the file with the specified index to the new name. The new filename is
reflected by the <tt class="docutils literal"><span class="pre">file_storage</span></tt> returned by <tt class="docutils literal"><span class="pre">files()</span></tt> but not by the one
returned by <tt class="docutils literal"><span class="pre">orig_files()</span></tt>.</p>
<p>If you want to rename the base name of the torrent (for a multifile torrent), you
can copy the <tt class="docutils literal"><span class="pre">file_storage</span></tt> (see <a class="reference internal" href="#files-orig-files">files() orig_files()</a>), change the name, and
then use <a class="reference internal" href="#remap-files">remap_files()</a>.</p>
</div>
<div class="section" id="begin-files-end-files-rbegin-files-rend-files">
<h2>begin_files() end_files() rbegin_files() rend_files()</h2>

6
docs/manual.rst
View File

@ -1582,7 +1582,7 @@ files() orig_files()
::
file_storage const& file() const;
file_storage const& files() const;
file_storage const& orig_files() const;
The ``file_storage`` object contains the information on how to map the pieces to
@ -1623,6 +1623,10 @@ Renames a the file with the specified index to the new name. The new filename is
reflected by the ``file_storage`` returned by ``files()`` but not by the one
returned by ``orig_files()``.
If you want to rename the base name of the torrent (for a multifile torrent), you
can copy the ``file_storage`` (see `files() orig_files()`_), change the name, and
then use `remap_files()`_.
begin_files() end_files() rbegin_files() rend_files()
-----------------------------------------------------