From: Joey Hess <joeyh@joeyh.name>
To: git@vger.kernel.org
Cc: Joey Hess <joeyh@joeyh.name>
Subject: [PATCH v3 1/8] clarify %f documentation
Date: Wed, 22 Jun 2016 16:21:26 -0400 [thread overview]
Message-ID: <20160622202133.23565-2-joeyh@joeyh.name> (raw)
In-Reply-To: <20160622202133.23565-1-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 e3b1de8..145dd10 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
--
2.9.0.8.g973eabb.dirty
next prev parent reply other threads:[~2016-06-22 20:22 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-22 20:21 [PATCH v3 0/8] extend smudge/clean filters with direct file access Joey Hess
2016-06-22 20:21 ` Joey Hess [this message]
2016-06-22 20:21 ` [PATCH v3 2/8] add smudgeToFile and cleanFromFile filter configs Joey Hess
2016-06-22 20:21 ` [PATCH v3 3/8] use cleanFromFile in git add Joey Hess
2016-06-22 20:21 ` [PATCH v3 4/8] use smudgeToFile in git checkout etc Joey Hess
2016-06-22 20:21 ` [PATCH v3 5/8] warn on unusable smudgeToFile/cleanFromFile config Joey Hess
2016-06-22 20:21 ` [PATCH v3 6/8] better recovery from failure of smudgeToFile filter Joey Hess
2016-06-22 20:21 ` [PATCH v3 7/8] use smudgeToFile filter in git am Joey Hess
2016-06-22 20:21 ` [PATCH v3 8/8] use smudgeToFile filter in recursive merge Joey Hess
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20160622202133.23565-2-joeyh@joeyh.name \
--to=joeyh@joeyh.name \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).