git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Marc Branchaud <marcnarc@xiplink.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Fredrik Gustafsson <iveqy@iveqy.com>
Subject: [PATCH v2] Provide some linguistic guidance for the documentation.
Date: Thu,  1 Aug 2013 11:10:25 -0400	[thread overview]
Message-ID: <1375369825-28636-1-git-send-email-marcnarc@xiplink.com> (raw)
In-Reply-To: <1375197114-10742-1-git-send-email-marcnarc@xiplink.com>

This will hopefully avoid questions over which spelling and grammar should
be used.  Translators are of course free to create localizations for other
specific English dialects.

Signed-off-by: Marc Branchaud <marcnarc@xiplink.com>
---

A little less stringent now.

 Documentation/CodingGuidelines  |  6 ++++++
 Documentation/SubmittingPatches | 10 ++++++++++
 2 files changed, 16 insertions(+)

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 559d5f9..fc397f3 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -242,6 +242,12 @@ Writing Documentation:
  processed into HTML and manpages (e.g. git.html and git.1 in the
  same directory).
 
+ 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.
+
  Every user-visible change should be reflected in the documentation.
  The same general rule as for code applies -- imitate the existing
  conventions.  A few commented examples follow to provide reference
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index d0a4733..998e407 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -65,6 +65,16 @@ feature does not trigger when it shouldn't.  Also make sure that the
 test suite passes after your commit.  Do not forget to update the
 documentation to describe the updated behaviour.
 
+Speaking of the documentation, if you are attempting to correct typographical
+or grammatical errors use one patch for indisputably correct changes (e.g.
+"teh" -> "the") and put subjective/stylistic changes in a separate patch.
+This helps to streamline reviews of your patches.  Also, although the
+documentation is mainly written in US English, most non-US spelling variants
+are acceptable.  Patches that change one common spelling to another (such as
+changing "behaviour" to "behavior") are generally not helpful, as
+oftentimes a few months later some generous soul will want to change the
+spelling the other way.
+
 Oh, another thing.  I am picky about whitespaces.  Make sure your
 changes do not trigger errors with the sample pre-commit hook shipped
 in templates/hooks--pre-commit.  To help ensure this does not happen,
-- 
1.8.3.1

  parent reply	other threads:[~2013-08-01 15:10 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-07-29 21:15 [PATCH] Documentation: fix typos in man pages Øystein Walle
2013-07-30 14:51 ` Marc Branchaud
2013-07-30 15:05   ` Junio C Hamano
2013-07-30 15:11   ` [PATCH] Specify UK English for the documentation source files Marc Branchaud
2013-07-30 15:52     ` Fredrik Gustafsson
2013-07-30 16:40     ` Junio C Hamano
2013-08-01 15:10     ` Marc Branchaud [this message]
2013-08-01 15:14       ` [PATCH v2] Provide some linguistic guidance for the documentation Marc Branchaud
2013-08-01 18:21       ` Junio C Hamano
2013-08-01 18:49         ` [PATCH v3] " Marc Branchaud
2013-08-02  6:25         ` [PATCH v2] " Jonathan Nieder
2013-08-02 14:16           ` Marc Branchaud

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1375369825-28636-1-git-send-email-marcnarc@xiplink.com \
    --to=marcnarc@xiplink.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=iveqy@iveqy.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).