[PATCH v5 1/8] clarify %f documentation
- From
Joey Hess <joeyh@joeyh.name>
- Date
- Jul 11, 2016, 22:45 UTC
- Message-ID
- <1468277112-9909-2-git-send-email-joeyh@joeyh.name>
- In-Reply-To
- <1468277112-9909-1-git-send-email-joeyh@joeyh.name>
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> --- Documentation/gitattributes.txt | 5 +++++ 1 file changed, 5 insertions(+)
diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt index f2afdb6..197ece8 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -379,6 +379,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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- 2.8.1