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

[PATCH] Grammar fixes for gitattributes documentation

From
Wincent Colaiuta <win@wincent.com>
Date
Nov 14, 2007, 07:51 UTC
Message-ID
<33080F0B-80C0-4860-9A74-C6878EE3B2CD@wincent.com>

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>
---
  Documentation/gitattributes.txt |   17 +++++++++--------
  1 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/Documentation/gitattributes.txt b/Documentation/ 
gitattributes.txt
index 20cf8ff..b01786b 100644
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt
@@ -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 which 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
-- 
1.5.3.5
Next: Junio C Hamano
Message 1 of 7 in “Grammar fixes for gitattributes documentation”
  1. Grammar fixes for gitattributes documentationWincent Colaiuta, Nov 14, 2007
  2. Junio C HamanoNov 14, 2007
  3. Wincent ColaiutaNov 14, 2007
  4. Junio C HamanoNov 14, 2007
  5. Jeff KingNov 15, 2007
  6. David SymondsNov 15, 2007
  7. Jeff KingNov 15, 2007

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.