[PATCH 1/4] clarify %f documentation
From: Joey Hess <hidden>
Date: 2016-06-16 20:33:57
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
It's natural to expect %f to be an actual file on disk; help avoid that mistake. Signed-off-by: Joey Hess <redacted> --- Documentation/gitattributes.txt | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
index e3b1de8..e077cc9 100644
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt@@ -365,8 +365,8 @@ you can declare that the filter is `required`, in the configuration: ------------------------ Sequence "%f" on the filter command line is replaced with the name of -the file the filter is working on. A filter might use this in keyword -substitution. For example: +the file in the git repository the filter is working on. +A filter might use this in keyword substitution. For example: ------------------------ [filter "p4"]
@@ -374,6 +374,9 @@ substitution. For example: smudge = git-p4-filter --smudge %f ------------------------ +Note that the "%f" is the name of a file in the git repository; the +corresponding file on disk may not exist, or may have unrelated contents to +what git is filtering. Interaction between checkin/checkout attributes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
--
2.9.0.4.g2856e74.dirty