@matheusbsbs / matheus-bagliano / commits / c05ef93879
Fork 0

Grammar fixes for gitattributes documentation

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>

Wincent Colaiuta committed Nov 14, 2007 at 08:51 UTC c05ef93879696638406cad5be54be577a2666d04
1 file changed +9 -8
Documentation/gitattributes.txt
+9 -8
@@ -148,22 +148,23 @@ with `$Id$` upon check-in.
148 `filter`
149 ^^^^^^^^
150
151 -A `filter` attribute can be set to a string value. This names
151 +A `filter` attribute can be set to a string value that names a
152 filter driver specified in the configuration.
153
154 -A filter driver consists of `clean` command and `smudge`
154 +A filter driver consists of a `clean` command and a `smudge`
155 command, either of which can be left unspecified. Upon
156 -checkout, when `smudge` command is specified, the command is fed
157 -the blob object from its standard input, and its standard output
158 -is used to update the worktree file. Similarly, `clean` command
159 -is used to convert the contents of worktree file upon checkin.
156 +checkout, when the `smudge` command is specified, the command is
157 +fed the blob object from its standard input, and its standard
158 +output is used to update the worktree file. Similarly, the
159 +`clean` command is used to convert the contents of worktree file
160 +upon checkin.
161
161 -Missing filter driver definition in the config is not an error
162 +A missing filter driver definition in the config is not an error
163 but makes the filter a no-op passthru.
164
165 The content filtering is done to massage the content into a
166 shape that is more convenient for the platform, filesystem, and
166 -the user to use. The keyword here is "more convenient" and not
167 +the user to use. The key phrase here is "more convenient" and not
168 "turning something unusable into usable". In other words, the
169 intent is that if someone unsets the filter driver definition,
170 or does not have the appropriate filter program, the project