Re: [PATCH]: fix typos in docs

From: Junio C Hamano <gitster@pobox.com>
Date: Jul 4, 2008, 19:37 UTC
Message-ID: <7v63rlv3si.fsf@gitster.siamese.dyndns.org>
In-Reply-To: <877ic1sg47.fsf@offby1.atm01.sea.blarg.net>

Eric Hanchrow <offby1@blarg.net> writes:

> From 098e3ec480254069d944e494a42afcf2013d08d7 Mon Sep 17 00:00:00 2001
> From: Eric Hanchrow <offby1@blarg.net>
> Date: Mon, 30 Jun 2008 23:34:08 -0700
> Subject: [PATCH] Fix typos

Unnecessarily duplicated headers. Please drop them, especially the first one (the latter three are fine if the difference between them and what appears in your e-mail header matters).

> diff --git a/Documentation/.gitignore b/Documentation/.gitignore
> index d8edd90..ce24e4a 100644
> --- a/Documentation/.gitignore
> +++ b/Documentation/.gitignore

This part does not look like "fix typos" at all, and is an unrelated change. Explain in the commit log message please.

Show 12 quoted lines

> diff --git a/Documentation/config.txt b/Documentation/config.txt
> -	then 'gitcvs.allbinary' is used. See linkgit:gitattribute[5].
> +	then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
> diff --git a/Documentation/git.txt b/Documentation/git.txt
> -linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
> +linkgit:everyday[7], linkgit:gitcvs-migration[7],
> diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
> -linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
> +linkgit:everyday[7], linkgit:gitcvs-migration[7],
> diff --git a/Documentation/gitglossary.txt b/Documentation/gitglossary.txt
> -linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
> +linkgit:everyday[7], linkgit:gitcvs-migration[7],

These are "fix broken links" aren't they? Please make them into a separate patch that has only "fix broken links" and nothing else.

The remaining are rewording, "fix grammar", with one typofix; it is good to include them in a single patch but please give a bit better label.

Please split this into at least two, possibly three patches:

 (0) A change to Documentation/.gitignore with justification.  As far as I
     can see, the two files you added are not built products nor cruft
     left by our build procedure.

 (1) "Documentation: fix broken links".

 (2) "Documentation: fix grammar and typo, and reword for readability".