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

Re: [PATCH v2] Provide some linguistic guidance for the documentation.

From
Junio C Hamano <gitster@pobox.com>
Date
Aug 1, 2013, 18:21 UTC
Message-ID
<7vfvuts25p.fsf@alter.siamese.dyndns.org>
In-Reply-To
<1375369825-28636-1-git-send-email-marcnarc@xiplink.com>
Marc Branchaud <marcnarc@xiplink.com> writes:
Show 5 quoted lines
> + The documentation generally follows US English (en_US) norms for spelling
> + and grammar, although most spelling variations are tolerated.  Just avoid
> + mixing styles when updating existing text.  If you wish to correct the
> + English of some of the existing documentation, please see the documentation-
> + related advice in the Documentation/SubmittingPatches file.
Is that accurate?  My impression has been:
    The documentation liberally mixes US and UK English (en_US/UK)
    norms for spelling and grammar, which is somewhat unfortunate.
    In an ideal world, it would have been better if it consistently
    used only one and not the other, and we would have picked en_US.
    A huge patch that touches the files all over the place only to
    correct the inconsistency is not welcome, though.  Potential
    clashes with other changes that can result from such a patch is
    simply not worth it.  What we would want is to gradually convert
    them, with small and easily digestable patches, as a side effect
    of doing some other _real_ work in the vicinity (e.g. rewriting
    a paragraph to clarify, while turning en_UK spelling to en_US).
Previous: Marc BranchaudNext: Marc Branchaud
Message 9 of 12 in “Documentation: fix typos in man pages”
  1. Documentation: fix typos in man pagesØystein Walle, Jul 29, 2013
  2. Marc BranchaudJul 30, 2013
  3. Junio C HamanoJul 30, 2013
  4. Specify UK English for the documentation source files.Marc Branchaud, Jul 30, 2013
  5. Fredrik GustafssonJul 30, 2013
  6. Junio C HamanoJul 30, 2013
  7. Provide some linguistic guidance for the documentation.Marc Branchaud, Aug 1, 2013
  8. Marc BranchaudAug 1, 2013
  9. Junio C HamanoAug 1, 2013
  10. Provide some linguistic guidance for the documentation.Marc Branchaud, Aug 1, 2013
  11. Jonathan NiederAug 2, 2013
  12. Marc BranchaudAug 2, 2013

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.