undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

clarify %f documentation

Browse Source 
It's natural to expect %f to be an actual file on disk; help avoid that
mistake.

Signed-off-by: Joey Hess <joeyh@joeyh.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Joey Hess 2016-07-11 18:45:05 -04:00 committed by Junio C Hamano
parent 08df31eecc
commit 52db4b0467
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/gitattributes.txt
View File

@ -374,6 +374,11 @@ substitution. For example:
smudge = git-p4-filter --smudge %f smudge = git-p4-filter --smudge %f
------------------------ ------------------------
Note that "%f" is the name of the path that is being worked on. Depending
on the version that is being filtered, the corresponding file on disk may
not exist, or may have different contents. So, smudge and clean commands
should not try to access the file on disk, but only act as filters on the
content provided to them on standard input.
Interaction between checkin/checkout attributes Interaction between checkin/checkout attributes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^