From fbbe6f498a874d75fde3fd0c7fd38605be0465ef Mon Sep 17 00:00:00 2001
From: Stephan Bosch <stephan@rename-it.nl>
Date: Mon, 24 Mar 2008 23:29:00 +0100
Subject: [PATCH] Updated documentation.

---
 README                                        | 27 +++++++++++++------
 src/lib-sieve/plugins/include/ext-include.c   |  4 ---
 .../plugins/variables/ext-variables.c         |  5 ++--
 3 files changed, 22 insertions(+), 14 deletions(-)

diff --git a/README b/README
index 1998cf91b..f0ffe6f3e 100644
--- a/README
+++ b/README
@@ -134,13 +134,16 @@ Extensions and their implementation status:
     copy: full
     regex: full, but suboptimal
     body: full, but text body-transform implementation is simple
-    include: full, but needs much more work
-    vacation: almost complete, but no support for required References header
-    imapflags: flag management works, but flags are not stored 
-    variables: very basic support
+    include: almost full; needs more work (no variables; no external binaries)
+    vacation: almost full; no support for required References header
+    imapflags: flag management works, but flags are not stored (no variables)
+    variables: untested core functionality present; need to provide support
+               other extensions that depend on this one
 
-    notify: planned, first mailto only (- very low priority)
-	editheader: planned, needs additional support from Dovecot though.
+  Low priority:
+    notify: planned, first mailto only 
+    editheader: planned, needs additional support from Dovecot though.
+    mimeloop: planned
 
 All implemented extensions are like the engine itself currently very much 
 experimental. A status of 'full' does not mean that the extension is bug-free 
@@ -200,12 +203,15 @@ TODO
 Current:
 * Implement variables extension
   Implemented:
-  -> Core variables substitution works
+  -> Core variable substitution works
   -> Accept namespaces (parse, no real support; proper error messages)
   -> Support match variables
   Current:
   -> Provide support for include, imapflags and other extensions that (partly)
      depend on variables support.
+  -> Implement variables support for include extension
+  Remaining:
+  -> Implement variabls support for imapflags extension
      
 Next (in order of descending priority/precedence):
 * Finish implementing all extensions supported by cmusieve, except notify.
@@ -231,7 +237,8 @@ Next (in order of descending priority/precedence):
 * Make sure cmusieve can be replaced seamlessly with this new plugin.
 * Make a few elaborate test scripts to test engine and all implemented 
   extensions a little better. Also include specially crafted e-mail messages 
-  that give deterministic and thus testable results.
+  that give deterministic and thus testable results. 
+  (This might become an initial version of the test suite)
 
 * ## MAKE A FIRST RELEASE ##
 
@@ -245,8 +252,12 @@ Next (in order of descending priority/precedence):
 * Make the engine and its extensions much more configurable. Possibly this can 
   be merged with Dovecot's new master config implementation.
 * Implement notify extension with sole support for mailto mechanism. 
+* Implement editheader extension
+* Implement mimeloop extension
 * Give the byte code format some more thought, it is currently quite rough and
   to the point. 
 * Try to implement proposed notify mechanisms other than mailto. Currently: xmpp
   and sip
+* Implement namespace support for variables extension 
+  (possibly needed by test suite; in that case priority is much higher)
 
diff --git a/src/lib-sieve/plugins/include/ext-include.c b/src/lib-sieve/plugins/include/ext-include.c
index 28536ef93..91e14a768 100644
--- a/src/lib-sieve/plugins/include/ext-include.c
+++ b/src/lib-sieve/plugins/include/ext-include.c
@@ -13,10 +13,6 @@
  * the resulting byte code is imported into the main binary in separate blocks.
  */
  
-/* FIXME: As long as variables extension is not implemented, this extension will
- * not define import/export commands.
- */
-
 #include "lib.h"
 
 #include "sieve-common.h"
diff --git a/src/lib-sieve/plugins/variables/ext-variables.c b/src/lib-sieve/plugins/variables/ext-variables.c
index 6012e368c..021b97e32 100644
--- a/src/lib-sieve/plugins/variables/ext-variables.c
+++ b/src/lib-sieve/plugins/variables/ext-variables.c
@@ -3,14 +3,15 @@
  *
  * Authors: Stephan Bosch
  * Specification: RFC 5229
- * Implementation: basic variables support
+ * Implementation: full variables support, working on support for other 
+ *                 extensions.
  * Status: under development
  *
  */
  
 /* FIXME: This implementation of the variables extension does not support 
  * namespaces. It recognizes them, but there is currently no support to let
- * a an extension register a new namespace. Currently no such extension exists 
+ * an extension register a new namespace. Currently no such extension exists 
  * and therefore this support has a very low implementation priority.
  */
 
-- 
GitLab