diff options
| author | Joey Hess <joeyh@joeyh.name> | 2016-07-11 18:45:05 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2016-08-03 10:10:35 -0700 |
| commit | 52db4b0467f157230d2746f10435d070ad859bae (patch) | |
| tree | 6807fbc6b8303f781118836e25a5ee497163e2f3 | |
| parent | 08df31eeccfe1576971ea4ba42570a424c3cfc41 (diff) | |
| download | git-jh/clean-smudge-f-doc.tar.gz | |
clarify %f documentationjh/clean-smudge-f-doc
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 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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |