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

Re: [PATCH] Documentation: git-format-patch.txt rewordings and cleanups

From
Stephen Boyd <bebarino@gmail.com>
Date
Mar 24, 2009, 23:36 UTC
Message-ID
<780e0a6b0903241636j4749daf3xddb6e4c200c00820@mail.gmail.com>
In-Reply-To
<20090324220913.GN19389@fieldses.org>
On Tue, Mar 24, 2009 at 3:09 PM, J. Bruce Fields <bfields@fieldses.org> wrote:
Show 23 quoted lines
> On Mon, Mar 23, 2009 at 03:21:23AM -0700, Stephen Boyd wrote:
>>  +
>> -Note that you would need to include the leading dot `.` if you
>> -want a filename like `0001-description-of-my-change.patch`, and
>> -the first letter does not have to be a dot.  Leaving it empty would
>> -not add any suffix.
>> +Note the first letter is not required to be a dot, you will need to
>> +include the leading dot `.` if you want a filename like
>> +`0001-description-of-my-change.patch`.
>
> That's a comma-splice, trivially fixed by changing "dot, you" to "dot;
> you".
>
> Better?: "Note that the leading dot isn't actually required if you don't
> want a dot between the patch name and the suffix."
>
> (Though personally I'd strike the whole sentence, since a) probably
> nobody cares, and b) the 1 in a million person that does actually want
> to do this can figure it out easily enough on their own with a quick
> test.)
>
> --b.
>

I don't think documentation is meant to point the user to trial and error. Even if the error is fairly harmless. Although you could be right that nobody cares.

How about a sentence with no negation?

"Note that the leading dot is required if you want a dot between the patch name and the suffix."

Previous: J. Bruce FieldsNext: J. Bruce Fields
Message 3 of 7 in “Documentation: git-format-patch.txt rewordings and cleanups”
  1. Documentation: git-format-patch.txt rewordings and cleanupsStephen Boyd, Mar 23, 2009
  2. J. Bruce FieldsMar 24, 2009
  3. Stephen BoydMar 24, 2009
  4. J. Bruce FieldsMar 24, 2009
  5. Junio C HamanoMar 24, 2009
  6. Stephen BoydMar 25, 2009
  7. Junio C HamanoMar 25, 2009

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.