From 52db4b0467f157230d2746f10435d070ad859bae Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 11 Jul 2016 18:45:05 -0400 Subject: [PATCH] clarify %f documentation It's natural to expect %f to be an actual file on disk; help avoid that mistake. Signed-off-by: Joey Hess Signed-off-by: Junio C Hamano --- Documentation/gitattributes.txt | 5 +++++ 1 file changed, 5 insertions(+) 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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^