Update gnus-sync.el docs.

* gnus-sync.el: Update docs to explain state and plans.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 903b80c..e87619e 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,7 @@
 2010-10-07  Teodor Zlatanov  <tzz@lifelogs.com>
 
 2010-10-07  Teodor Zlatanov  <tzz@lifelogs.com>
 

+       * gnus-sync.el: Update docs to explain state and plans.
+

        * gnus-int.el (gnus-after-set-mark-hook, gnus-before-update-mark-hook):
        Hooks for mark updates.
        (gnus-request-set-mark, gnus-request-update-mark): Use them.
        * gnus-int.el (gnus-after-set-mark-hook, gnus-before-update-mark-hook):
        Hooks for mark updates.
        (gnus-request-set-mark, gnus-request-update-mark): Use them.

diff --git a/lisp/gnus-sync.el b/lisp/gnus-sync.el
index c0e52b6..8a492e8 100644 (file)
--- a/lisp/gnus-sync.el
+++ b/lisp/gnus-sync.el
@@ -24,6 +24,10 @@
 
 ;; This is the gnus-sync.el package.
 
 
 ;; This is the gnus-sync.el package.
 

+;; It's due for a rewrite using gnus-after-set-mark-hook and
+;; gnus-before-update-mark-hook.  Until then please consider it
+;; experimental.
+

 ;; Put this in your startup file (~/.gnus.el for instance)
 
 ;; possibilities for gnus-sync-backend:
 ;; Put this in your startup file (~/.gnus.el for instance)
 
 ;; possibilities for gnus-sync-backend:


@@ -40,6 +44,9 @@
 
 ;; - after gnus-sync-read, the message counts are wrong
 
 
 ;; - after gnus-sync-read, the message counts are wrong
 

+;; - use gnus-after-set-mark-hook and gnus-before-update-mark-hook to
+;;   catch the mark updates
+

 ;;; Code:
 
 (eval-when-compile (require 'cl))
 ;;; Code:
 
 (eval-when-compile (require 'cl))