mirror/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-11-18 23:13:58 +01:00
Code

Grammar fixes for gitattributes documentation

Browse Source 
Tweak the "filter" section of the gitattributes documentation to add
some
missing articles and improve some word choices without changing the
semantics of the section.

Signed-off-by: Wincent Colaiuta <win@wincent.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Wincent Colaiuta 2007-11-14 08:51:41 +01:00 committed by Junio C Hamano
parent 436e7a74c6
commit c05ef93879
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Documentation/gitattributes.txt
View File

@ -148,22 +148,23 @@ with `$Id$` upon check-in.
`filter`
^^^^^^^^
A `filter` attribute can be set to a string value. This names
A `filter` attribute can be set to a string value that names a
filter driver specified in the configuration.
A filter driver consists of `clean` command and `smudge`
A filter driver consists of a `clean` command and a `smudge`
command, either of which can be left unspecified. Upon
checkout, when `smudge` command is specified, the command is fed
the blob object from its standard input, and its standard output
is used to update the worktree file. Similarly, `clean` command
is used to convert the contents of worktree file upon checkin.
checkout, when the `smudge` command is specified, the command is
fed the blob object from its standard input, and its standard
output is used to update the worktree file. Similarly, the
`clean` command is used to convert the contents of worktree file
upon checkin.
Missing filter driver definition in the config is not an error
A missing filter driver definition in the config is not an error
but makes the filter a no-op passthru.
The content filtering is done to massage the content into a
shape that is more convenient for the platform, filesystem, and
the user to use. The keyword here is "more convenient" and not
the user to use. The key phrase here is "more convenient" and not
"turning something unusable into usable". In other words, the
intent is that if someone unsets the filter driver definition,
or does not have the appropriate filter program, the project