Merge branch 'nd/index-format-doc' into maint
authorJunio C Hamano <gitster@pobox.com>
Sun, 23 Dec 2012 04:37:09 +0000 (20:37 -0800)
committerJunio C Hamano <gitster@pobox.com>
Sun, 23 Dec 2012 04:37:09 +0000 (20:37 -0800)
* nd/index-format-doc:
  index-format.txt: clarify what is "invalid"

Documentation/technical/index-format.txt

index 57d6f91..7324154 100644 (file)
@@ -161,8 +161,9 @@ GIT index format
     this span of index as a tree.
 
   An entry can be in an invalidated state and is represented by having
-  -1 in the entry_count field. In this case, there is no object name
-  and the next entry starts immediately after the newline.
+  a negative number in the entry_count field. In this case, there is no
+  object name and the next entry starts immediately after the newline.
+  When writing an invalid entry, -1 should always be used as entry_count.
 
   The entries are written out in the top-down, depth-first order.  The
   first entry represents the root level of the repository, followed by the