(dir-status): Add a brief description.

2 files changed, 17 insertions, 0 deletions

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index cc1c4462914..69fe9bca1f3 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2008-02-19  Dan Nicolaescu  <dann@ics.uci.edu>
+
+        * vc.el (dir-status): Add a brief description.
+
 2008-02-19  Thien-Thi Nguyen  <ttn@gnuvola.org>
 
         * vc-hooks.el (vc-find-root): Take optional arg INVERT.
diff --git a/lisp/vc.el b/lisp/vc.el
index cc9f89dd109..3376113711a 100644
--- a/lisp/vc.el
+++ b/lisp/vc.el
@@ -167,6 +167,19 @@
 ;;   in older versions this method was not required to recurse into
 ;;   subdirectories.)
 ;;
+;; - dir-status (dir update-function status-buffer)
+;;
+;;   Produce RESULT: a list of conses of the form (file . vc-state)
+;;   for the files in DIR.  If a command needs to be run to compute
+;;   this list, it should be run asynchronously.  When RESULT is
+;;   computed, it should be passed back by doing:
+;;       (funcall UPDATE-FUNCTION RESULT STATUS-BUFFER)
+;;   This function is used by vc-status, a replacement for vc-dired.
+;;   vc-status is still under development, and is NOT feature
+;;   complete.  As such, the requirements for this function might
+;;   change.
+;;   This is a replacement for dir-state.
+;;
 ;; * working-revision (file)
 ;;
 ;;   Return the working revision of FILE.  This is the revision fetched