From 28ca7f83033ff25150470d464b6228b8d9d989fe Mon Sep 17 00:00:00 2001 From: arvidn Date: Wed, 17 Feb 2016 18:43:57 -0800 Subject: [PATCH] update documentation to mention read_resume_data() --- docs/manual.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/manual.rst b/docs/manual.rst index 231bbaab8..6c8eb9fa9 100644 --- a/docs/manual.rst +++ b/docs/manual.rst @@ -356,11 +356,12 @@ fast-resume data. The fast-resume data also contains information about which blocks, in the unfinished pieces, were downloaded, so it will not have to start from scratch on the partially downloaded pieces. -To use the fast-resume data you simply give it to async_add_torrent() and -add_torrent(), and it will skip the time consuming checks. It may have to do +To use the fast-resume data you pass it to read_resume_data(), which will return +an add_torrent_params object. Fields of this object can then be altered before +passing it to async_add_torrent() or add_torrent(). +The session will then skip the time consuming checks. It may have to do the checking anyway, if the fast-resume data is corrupt or doesn't fit the -storage for that torrent, then it will not trust the fast-resume data and just -do the checking. +storage for that torrent. file format -----------