From cf6740e99602feb44d1213418e21559d7ac013ef Mon Sep 17 00:00:00 2001
From: Arvid Norberg
Date: Tue, 20 Nov 2007 10:00:49 +0000
Subject: [PATCH] updated write_resume_data docs
---
docs/manual.html | 10 ++++++++--
docs/manual.rst | 12 ++++++++++--
2 files changed, 18 insertions(+), 4 deletions(-)
diff --git a/docs/manual.html b/docs/manual.html
index 8453b376f..b41d6f55d 100644
--- a/docs/manual.html
+++ b/docs/manual.html
@@ -1781,9 +1781,15 @@ is still downloading! The recommended practice is to first pause the torrent, th
fast resume data, and then close it down. Since the disk IO is done in a separate thread, in order
to synchronize, you shoule to wait for the torrent_paused_alert before you write the resume
data.
+In full allocation mode the reume data is never invalidated by subsequent
+writes to the files, since pieces won't move around. This means that you don't need to
+pause before writing resume data in full or sparse mode. If you don't, however, any data written to
+disk after you saved resume data and before the session closed is lost.
+It also means that if the resume data is out dated, libtorrent will not re-check the files, but assume
+that it is fairly recent. The assumption is that it's better to loose a little bit than to re-check
+the entire file.
It is still a good idea to save resume data periodically during download as well as when
-closing down. In full allocation mode the reume data is never invalidated by subsequent
-writes to the files, since pieces won't move around.
+closing down.
diff --git a/docs/manual.rst b/docs/manual.rst
index 4dc7c2761..b7880e788 100644
--- a/docs/manual.rst
+++ b/docs/manual.rst
@@ -1759,9 +1759,17 @@ fast resume data, and then close it down. Since the disk IO is done in a separat
to synchronize, you shoule to wait for the ``torrent_paused_alert`` before you write the resume
data.
+In full allocation mode the reume data is never invalidated by subsequent
+writes to the files, since pieces won't move around. This means that you don't need to
+pause before writing resume data in full or sparse mode. If you don't, however, any data written to
+disk after you saved resume data and before the session closed is lost.
+
+It also means that if the resume data is out dated, libtorrent will not re-check the files, but assume
+that it is fairly recent. The assumption is that it's better to loose a little bit than to re-check
+the entire file.
+
It is still a good idea to save resume data periodically during download as well as when
-closing down. In full allocation mode the reume data is never invalidated by subsequent
-writes to the files, since pieces won't move around.
+closing down.
status()