[Emacs-diffs] /srv/bzr/emacs/trunk r99855: Improve documentation comments.

[Eric S. Raymond]

------------------------------------------------------------
revno: 99855
committer: Eric S. Raymond <address@hidden>
branch nick: trunk
timestamp: Fri 2010-04-09 10:17:52 -0400
message:
  Improve documentation comments.
modified:
  lisp/ChangeLog
  lisp/vc-git.el
  lisp/vc-hooks.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2010-04-08 19:59:46 +0000
+++ b/lisp/ChangeLog    2010-04-09 14:17:52 +0000
@@ -1,3 +1,7 @@
+2010-04-09  Eric Raymond  <address@hidden>
+
+       * vc-hooks.el, vc-git.el: Improve documentation comments.
+
 2010-04-08  Stefan Monnier  <address@hidden>
 
        Fix some of the problems in defsubst* (bug#5728).

=== modified file 'lisp/vc-git.el'
--- a/lisp/vc-git.el    2010-04-07 05:56:35 +0000
+++ b/lisp/vc-git.el    2010-04-09 14:17:52 +0000
@@ -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))

=== modified file 'lisp/vc-hooks.el'
--- a/lisp/vc-hooks.el  2010-04-07 05:56:35 +0000
+++ b/lisp/vc-hooks.el  2010-04-09 14:17:52 +0000
@@ -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).