doc: make clear --assume-unchanged's user contract
authorPhilip Oakley <philipoakley@iee.org>
Sat, 6 Dec 2014 15:04:30 +0000 (15:04 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 9 Dec 2014 22:23:29 +0000 (14:23 -0800)
commitccadb25f730de775660c82695c5fcf9169f0aae7
treeaf704299ad5ee6f5cbe654cbbd2bfa8231ad656a
parent9181365b856a63f8c5486ad0fe48f1cd60852da3
doc: make clear --assume-unchanged's user contract

Many users misunderstand the --assume-unchanged contract, believing
it means Git won't look at the flagged file.

Be explicit that the --assume-unchanged contract is by the user that
they will NOT change the file so that Git does not need to look (and
expend, for example, lstat(2) cycles)

Mentioning "Git stops checking" does not help the reader, as it is
only one possible consequence of what that assumption allows Git to
do, but

   (1) there are things other than "stop checking" that Git can do
       based on that assumption; and
   (2) Git is not obliged to stop checking; it merely is allowed to.

Also, this is a single flag bit, correct the plural to singular, and
the verb, accordingly.

Drop the stale and incorrect information about "poor-man's ignore",
which is not what this flag bit is about at all.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-update-index.txt