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

From: Joey Hess <id@joeyh.name>
Date: Jun 17, 2016, 12:32 UTC
Message-ID: <20160617123209.GA24025@kitenet.net>
In-Reply-To: <xmqqfusc33aa.fsf@gitster.mtv.corp.google.com>

Junio C Hamano wrote:

Show 8 quoted lines

> "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.

-- 
see shy jo