From: Joey Hess <joeyh@joeyh.name>
To: git@vger.kernel.org
Cc: Joey Hess <joeyh@joeyh.name>
Subject: [PATCH 1/4] clarify %f documentation
Date: Thu, 16 Jun 2016 16:32:56 -0400 [thread overview]
Message-ID: <20160616203259.5886-2-joeyh@joeyh.name> (raw)
In-Reply-To: <20160616203259.5886-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 | 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
next prev parent reply other threads:[~2016-06-16 20:33 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-16 20:32 [PATCH 0/4] extend smudge/clean filters with direct file access Joey Hess
2016-06-16 20:32 ` Joey Hess [this message]
2016-06-16 21:33 ` [PATCH 1/4] clarify %f documentation Junio C Hamano
2016-06-17 2:48 ` Joey Hess
2016-06-17 3:25 ` Junio C Hamano
2016-06-17 12:32 ` Joey Hess
2016-06-17 15:57 ` Junio C Hamano
2016-06-16 20:32 ` [PATCH 2/4] add smudge-to-file and clean-from-file filter configuration Joey Hess
2016-06-16 21:57 ` Junio C Hamano
2016-06-17 13:13 ` Joey Hess
2016-06-17 18:26 ` Junio C Hamano
2016-06-17 6:05 ` Eric Sunshine
2016-06-17 9:36 ` Michael J Gruber
2016-06-17 12:47 ` Joey Hess
2016-06-17 16:09 ` Junio C Hamano
2016-06-17 17:29 ` Junio C Hamano
2016-06-17 17:37 ` Joey Hess
2016-06-17 18:06 ` Joey Hess
2016-06-17 18:24 ` Junio C Hamano
2016-06-16 20:32 ` [PATCH 3/4] use clean-from-file in git add Joey Hess
2016-06-16 20:32 ` [PATCH 4/4] use smudge-to-file in git checkout etc Joey Hess
2016-06-16 20:55 ` 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=20160616203259.5886-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).