diff options
author | Junio C Hamano <gitster@pobox.com> | 2016-08-10 11:55:34 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2016-08-10 11:55:34 -0700 |
commit | 019d8a409f6ff077c171589e89ac84f6575da86c (patch) | |
tree | ca8c2088556aa32b12058c6041a125aba05b8cf4 | |
parent | Merge branch 'rs/use-strbuf-addstr' into maint (diff) | |
parent | clarify %f documentation (diff) | |
download | tgif-019d8a409f6ff077c171589e89ac84f6575da86c.tar.xz |
Merge branch 'jh/clean-smudge-f-doc' into maint
A minor documentation update.
This was split out from a stalled jh/clean-smudge-annex topic
before discarding it.
* jh/clean-smudge-f-doc:
clarify %f documentation
-rw-r--r-- | Documentation/gitattributes.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt index e3b1de8033..145dd10967 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -374,6 +374,11 @@ substitution. For example: 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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |