git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Marc Branchaud <marcnarc@xiplink.com>
To: "Ondřej Bílka" <neleai@seznam.cz>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] More typofixes.
Date: Mon, 29 Jul 2013 10:55:41 -0400	[thread overview]
Message-ID: <51F6826D.2010606@xiplink.com> (raw)
In-Reply-To: <20130729081821.GA6758@domone.kolej.mff.cuni.cz>

On 13-07-29 04:18 AM, Ondřej Bílka wrote:
> Hi,
> 
> I improved my tool and it catched following additional typos.
> 
> As with any big project best way to catch errors is to have automated
> checks that catch them ( Other possibility would be to read everything ten
> times to get error rate down but nobody wants to do it).
> 
> If you want you could add a pre-commit hook 
> stylepp-spellcheck --hook
> that checks comments for likely typos (misspells by aspell and not
> occurring in code). It uses aspell to identify them so you need to 
> teach aspell which words are valid. 
> 
> I would like make possible to share dictionaries so teaching phase can
> be done only once instead for each person but I did not found suitable
> workflow yet.

Unfortunately no automated system is perfect (see some of my comments below).
 I'm all for an automated system that identifies potential misspellings, but
I'm wary of anything that attempts to automatically correct perceived errors,
or that can't be overruled.  In the end a human must make the final decision.

> Signed-off-by: Ondřej Bílka <neleai@seznam.cz>
> 
> diff --git a/pathspec.c b/pathspec.c
> index 6ea0867..27ffe77 100644
> --- a/pathspec.c
> +++ b/pathspec.c
> @@ -40,7 +40,7 @@ void add_pathspec_matches_against_index(const char **pathspec,
>  /*
>   * Finds which of the given pathspecs match items in the index.
>   *
> - * This is a one-shot wrapper around add_pathspec_matches_against_index()
> + * This is an one-shot wrapper around add_pathspec_matches_against_index()

As many others have already said, this is not a typo.

The use of "a" or "an" depends on whether or not the O's sound is hard or
soft.  So although we say "an orange" we also say "a one-in-a-million chance".

> 
>  [ ... snip ... ]
> 

> diff --git a/Documentation/RelNotes/1.7.9.1.txt b/Documentation/RelNotes/1.7.9.1.txt
> index 6957183..e8fddb8 100644
> --- a/Documentation/RelNotes/1.7.9.1.txt
> +++ b/Documentation/RelNotes/1.7.9.1.txt
> @@ -20,7 +20,7 @@ Fixes since v1.7.9
>     submodule that only has uncommitted local changes in the patch
>     prepared by for the user to edit.
>  
> - * Typo in "git branch --edit-description my-tpoic" was not diagnosed.
> + * Typo in "git branch --edit-description my-topic" was not diagnosed.

Here "tpoic" is illustrating the typo that was being misdiagnosed.

> 
>  [ ... snip ... ]
> 

> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index e0b923f..8420aff 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -434,11 +434,11 @@ core.repositoryFormatVersion::
>  	version.
>  
>  core.sharedRepository::
> -	When 'group' (or 'true'), the repository is made shareable between
> +	When 'group' (or 'true'), the repository is made sharable between
>  	several users in a group (making sure all the files and objects are
>  	group-writable). When 'all' (or 'world' or 'everybody'), the
>  	repository will be readable by all users, additionally to being
> -	group-shareable. When 'umask' (or 'false'), Git will use permissions
> +	group-sharable. When 'umask' (or 'false'), Git will use permissions

"Sharable" is the North American spelling.  AFAIK git doesn't specify what
kind of English the documentation source files should use.  Perhaps one day
there'll be en_UK and en_US translations, and all the sources will be written
in Klingon...

Until that day, or until the git project starts to care a lot more about
English style, I think patches that translate spellings between English
variants are a bit of a waste of time.

> 
>  [ ... snip ... ]
> 

> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
> index fe723e4..1491d69 100644
> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -3116,7 +3116,7 @@ Trust
>  If you receive the SHA-1 name of a blob from one source, and its contents
>  from another (possibly untrusted) source, you can still trust that those
>  contents are correct as long as the SHA-1 name agrees.  This is because
> -the SHA-1 is designed so that it is infeasible to find different contents
> +the SHA-1 is designed so that it is unfeasible to find different contents
>  that produce the same hash.
>  
>  Similarly, you need only trust the SHA-1 name of a top-level tree object

Both "infeasible" and "unfeasible" are in common usage.  If you want to avoid
future patches going back and forth on this, try "not feasible".

		M.

  parent reply	other threads:[~2013-07-29 14:55 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-07-29  8:18 [PATCH] More typofixes Ondřej Bílka
     [not found] ` <CAGyf7-HPB-SHNn3bsCkiAw42Qa+JhWJtiYirD8JJ2G5OXzixRQ@mail.gmail.com>
     [not found]   ` <CAGyf7-FCj=x9e54Z0o2GmpQeNNeqHKDhHxWP5XqMt5Sfs8i2wg@mail.gmail.com>
2013-07-29  9:18     ` Bryan Turner
2013-07-29  9:40 ` David Aguilar
2013-07-29 10:26 ` Ramkumar Ramachandra
2013-07-29 14:55 ` Marc Branchaud [this message]
2013-07-29 15:38   ` Ondřej Bílka
2013-07-29 17:38   ` Junio C Hamano
2013-07-29 17:52     ` Junio C Hamano
2013-07-29 17:59       ` Stefan Beller
2013-07-29 18:36       ` Marc Branchaud
2013-07-29 19:32         ` Junio C Hamano

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

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

  git send-email \
    --in-reply-to=51F6826D.2010606@xiplink.com \
    --to=marcnarc@xiplink.com \
    --cc=git@vger.kernel.org \
    --cc=neleai@seznam.cz \
    /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.
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 NNTP newsgroup(s).