changeset 107810:03ef65bf2e25

Improve documentation comments.
author Eric S. Raymond <esr@thyrsus.com>
date Fri, 09 Apr 2010 10:17:52 -0400
parents b4880c984e2f
children 2c6eaa7826c7
files lisp/ChangeLog lisp/vc-git.el lisp/vc-hooks.el
diffstat 3 files changed, 15 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/ChangeLog	Fri Apr 09 00:14:33 2010 +0300
+++ b/lisp/ChangeLog	Fri Apr 09 10:17:52 2010 -0400
@@ -1,3 +1,7 @@
+2010-04-09  Eric Raymond  <esr@snark.thyrsus.com>
+
+	* vc-hooks.el, vc-git.el: Improve documentation comments.
+
 2010-04-08  Stefan Monnier  <monnier@iro.umontreal.ca>
 
 	Fix some of the problems in defsubst* (bug#5728).
--- a/lisp/vc-git.el	Fri Apr 09 00:14:33 2010 +0300
+++ b/lisp/vc-git.el	Fri Apr 09 10:17:52 2010 -0400
@@ -171,7 +171,14 @@
 
 (defun vc-git-state (file)
   "Git-specific version of `vc-state'."
-  ;; FIXME: This can't set 'ignored yet
+  ;; FIXME: This can't set 'ignored or 'conflict yet
+  ;; The 'ignored state could be detected with `git ls-files -i -o
+  ;; --exclude-standard` It also can't set 'needs-update or
+  ;; 'needs-merge. The rough equivalent would be that upstream branch
+  ;; for current branch is in fast-forward state i.e. current branch
+  ;; is direct ancestor of corresponding upstream branch, and the file
+  ;; was modified upstream.  But we can't check that without a network
+  ;; operation.
   (if (not (vc-git-registered file))
       'unregistered
     (vc-git--call nil "add" "--refresh" "--" (file-relative-name file))
--- a/lisp/vc-hooks.el	Fri Apr 09 00:14:33 2010 +0300
+++ b/lisp/vc-hooks.el	Fri Apr 09 10:17:52 2010 -0400
@@ -460,6 +460,9 @@
   'edited            The working file has been edited by the user.  If
                      locking is used for the file, this state means that
                      the current version is locked by the calling user.
+                     This status should *not* be reported for files 
+                     which have a changed mtime but the same content 
+                     as the repo copy.
 
   USER               The current version of the working file is locked by
                      some other USER (a string).