[PATCH 1/3] Improve folderfilters documentation

[Sebastian Spaeth]

The text was confusing and not very helpful. Do away with the bad
folderfilters examples and describe a bit more what they are for.

Signed-off-by: Sebastian Spaeth <Sebastian at SSpaeth.de>
---
3 patches for our documentation. 1&3 are doc improvements, 2 removes the
scary THIS IS EXPERIMENTAL on the IDLE and sqlite features (plaintext is
still default).

 offlineimap.conf |   19 +++++++------------
 1 files changed, 7 insertions(+), 12 deletions(-)

diff --git a/offlineimap.conf b/offlineimap.conf
index 8cc2882..e055974 100644
--- a/offlineimap.conf
+++ b/offlineimap.conf
@@ -443,10 +443,12 @@ subscribedonly = no
 #
 # nametrans = lambda foldername: re.sub('^INBOX\.*', '.', foldername)
 
-# You can specify which folders to sync.  You can do it several ways.
-# I'll provide some examples.  The folderfilter operates on the
-# *UNTRANSLATED* name, if you specify nametrans.  It should return
-# true if the folder is to be included; false otherwise.
+# You can specify which folders to sync using the folderfilter
+# setting. You can provide any python function (e.g. a lambda function)
+# which will be invoked for each foldername. If the filter function
+# returns True, the folder will be synced, if it returns False, it. The
+# folderfilter operates on the *UNTRANSLATED* name (before any nametrans
+# translation takes place).
 #
 # Example 1: synchronizing only INBOX and Sent.
 #
@@ -470,14 +472,7 @@ subscribedonly = no
 # folderfilter = lambda foldername: foldername in
 #        ['INBOX', 'Sent Mail', 'Deleted Items',
 #         'Received']
-#
-# FYI, you could also include every folder with:
-#
-# folderfilter = lambda foldername: 1
-#
-# And exclude every folder with:
-#
-# folderfilter = lambda foldername: 0
+
 
 # You can specify folderincludes to include additional folders.
 # It should return a Python list.  This might be used to include a
-- 
1.7.4.1