[PATCH 3/3] documentation: Clarify restoreatime setting

Sebastian Spaeth Sebastian at SSpaeth.de
Thu Sep 15 14:06:32 BST 2011


Better document what this actually does and that most people won't be
needing it.

(Especially as mount setting such as relatime|noatime now reduce the
amount of atime changes anyway)

Signed-off-by: Sebastian Spaeth <Sebastian at SSpaeth.de>
---
 Changelog.draft.rst |    2 ++
 offlineimap.conf    |   10 +++++-----
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/Changelog.draft.rst b/Changelog.draft.rst
index 9063d5e..e4b8055 100644
--- a/Changelog.draft.rst
+++ b/Changelog.draft.rst
@@ -16,6 +16,8 @@ New Features
 Changes
 -------
 
+* Documentation improvements concerning 'restoreatime' and some code cleanup
+
 Bug Fixes
 ---------
 
diff --git a/offlineimap.conf b/offlineimap.conf
index 2d5532d..224e933 100644
--- a/offlineimap.conf
+++ b/offlineimap.conf
@@ -285,12 +285,12 @@ localfolders = ~/Test
 
 sep = .
 
-# Some users on *nix platforms may not want the atime (last access
-# time) to be modified by OfflineIMAP.  In these cases, they would
-# want to set restoreatime to yes.  OfflineIMAP will make an effort
-# to not touch the atime if you do that.
+# Some users may not want the atime (last access time) of folders to be
+# modified by OfflineIMAP.  If 'restoreatime' is set to yes, OfflineIMAP
+# will restore the atime of the "new" and "cur" folders in each maildir
+# folder to their original value after each sync.
 #
-# In most cases, the default of no should be sufficient.
+# In nearly all cases, the default should be fine.
 
 restoreatime = no
 
-- 
1.7.4.1





More information about the OfflineIMAP-project mailing list