diff options
| author | Joey Hess <joeyh@joeyh.name> | 2016-07-11 18:45:05 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2016-08-01 15:37:11 -0700 |
| commit | 6524514e434ff3f7fe31b2ef77d4d6f76ddaf566 (patch) | |
| tree | 50c233ccdc2d96748218be713efda0516383f5d3 | |
| parent | 45234cd3c4eee16e913927266434e1ad2d241660 (diff) | |
| download | git-6524514e434ff3f7fe31b2ef77d4d6f76ddaf566.tar.gz | |
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 <joeyh@joeyh.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -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 b40068bdfd..34db3e219b 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -377,6 +377,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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |