git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/4] clarify %f documentation

From
Junio C Hamano <gitster@pobox.com>
Date
Jun 17, 2016, 15:57 UTC
Message-ID
<xmqqbn2z3j0c.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<20160617123209.GA24025@kitenet.net>
Joey Hess <id@joeyh.name> writes:
Show 17 quoted lines
> Junio C Hamano wrote:
>> "tracked by Git" is not all that interesting, compared to the fact
>> that your filter needs to give contents relevant to that path
>> because that is what the command line argument Git gives you with
>> '%f' means.  It is not a random filename "tracked by Git".  Among 47
>> other files tracked by Git, the single one being given is the one
>> the code that drives the filter is WORKING ON, and I think that
>> needs to be written in the description, hence "the path that is
>> being worked on" was my suggestion.
>
> Ah, "being worked on" does clarify it well, I think:
>
> + 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.
Looks much better than the original text.  Thanks.

Another reason why you do not want to say "tracked" is for "git add" that adds a brand-new file that is not yet tracked. Technically, "trackable file" may work but we have to add "trackable" to the glossary, but so far we did without having to, and I'm reluctant to invent yet another word, so...

Previous: Joey HessNext: Joey Hess
Message 20 of 22 in “extend smudge/clean filters with direct file access”
  1. 0/4 extend smudge/clean filters with direct file accessJoey Hess, Jun 16, 2016
  2. 3/4 use clean-from-file in git addJoey Hess, Jun 16, 2016
  3. 2/4 add smudge-to-file and clean-from-file filter configurationJoey Hess, Jun 16, 2016
  4. Junio C HamanoJun 16, 2016
  5. Joey HessJun 17, 2016
  6. Junio C HamanoJun 17, 2016
  7. Eric SunshineJun 17, 2016
  8. Michael J GruberJun 17, 2016
  9. Joey HessJun 17, 2016
  10. Junio C HamanoJun 17, 2016
  11. Junio C HamanoJun 17, 2016
  12. Joey HessJun 17, 2016
  13. Joey HessJun 17, 2016
  14. Junio C HamanoJun 17, 2016
  15. 1/4 clarify %f documentationJoey Hess, Jun 16, 2016
  16. Junio C HamanoJun 16, 2016
  17. Joey HessJun 17, 2016
  18. Junio C HamanoJun 17, 2016
  19. Joey HessJun 17, 2016
  20. Junio C HamanoJun 17, 2016
  21. 4/4 use smudge-to-file in git checkout etcJoey Hess, Jun 16, 2016
  22. Joey HessJun 16, 2016

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.