git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Eric Hanchrow <offby1@blarg.net>
Cc: git@vger.kernel.org
Subject: Re: [PATCH]: fix typos in docs
Date: Fri, 04 Jul 2008 12:37:49 -0700	[thread overview]
Message-ID: <7v63rlv3si.fsf@gitster.siamese.dyndns.org> (raw)
In-Reply-To: <877ic1sg47.fsf@offby1.atm01.sea.blarg.net> (Eric Hanchrow's message of "Fri, 04 Jul 2008 10:39:52 -0700")

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.

> 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".

      reply	other threads:[~2008-07-04 19:38 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-07-04 17:39 [PATCH]: fix typos in docs Eric Hanchrow
2008-07-04 19:37 ` Junio C Hamano [this message]

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=7v63rlv3si.fsf@gitster.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=offby1@blarg.net \
    /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).