All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Thomas Ackermann <th.acker@arcor.de>
Cc: gitster@pobox.com, git@vger.kernel.org, davvid@gmail.com
Subject: Re: [PATCH 6/6] Use consistent links for User Manual and Everyday Git; Fix a quoting error
Date: Fri, 1 Feb 2013 11:51:40 -0800	[thread overview]
Message-ID: <20130201195140.GE12368@google.com> (raw)
In-Reply-To: <549641245.1090170.1359742373184.JavaMail.ngmail@webmail18.arcor-online.net>

Thomas Ackermann wrote:

> --- a/Documentation/git.txt
> +++ b/Documentation/git.txt
> @@ -23,7 +23,7 @@ and full access to internals.
>  
>  See linkgit:gittutorial[7] to get started, then see
>  link:everyday.html[Everyday Git] for a useful minimum set of
> -commands.  The link:user-manual.html[Git User's Manual] has a more
> +commands.  The link:user-manual.html[The Git User's Manual] has a more
>  in-depth introduction.

In the rendered version, this looks like:

	The The Git User's Manual[1] has a more in-depth introduction.

Presumably the first "The" should be dropped from either the link or
the surrounding text.

[...]
> --- a/Documentation/gitcore-tutorial.txt
> +++ b/Documentation/gitcore-tutorial.txt
> @@ -17,7 +17,7 @@ work with a Git repository.
>  
>  If you just need to use Git as a revision control system you may prefer
>  to start with "A Tutorial Introduction to Git" (linkgit:gittutorial[7]) or
> -link:user-manual.html[the Git User Manual].
> +link:user-manual.html[The Git User's Manual].

This comes out as

	... you may prefer to start with "A Tutorial Instruction to Git"
	(gittutorial(7)) or The Git User's Manual[1].

The capital 'T' in "The" looks a bit strange, but a lowercase 't' in
the corresponding footnote would also look strange.  We can't have
everything, I guess.

A possible fix would be to drop the "The" from the link.  The way you
have it here also seems fine.

[...]
> --- a/Documentation/gittutorial-2.txt
> +++ b/Documentation/gittutorial-2.txt
> @@ -406,7 +406,7 @@ pages for any of the git commands; one good place to start would be
>  with the commands mentioned in link:everyday.html[Everyday Git].  You
>  should be able to find any unknown jargon in linkgit:gitglossary[7].
>  
> -The link:user-manual.html[Git User's Manual] provides a more
> +The link:user-manual.html[The Git User's Manual] provides a more
>  comprehensive introduction to Git.

Doubled 'The'.

[...]
> --- a/Documentation/gittutorial.txt
> +++ b/Documentation/gittutorial.txt
> @@ -656,7 +656,7 @@ digressions that may be interesting at this point are:
>    * linkgit:gitworkflows[7]: Gives an overview of recommended
>      workflows.
>  
> -  * link:everyday.html[Everyday Git with 20 Commands Or So]
> +  * link:everyday.html[Everyday Git]

Isn't the old title more informative?

Thanks and hope that helps,
Jonathan

  parent reply	other threads:[~2013-02-01 19:52 UTC|newest]

Thread overview: 49+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-01-20 20:16 Aw: Re: [PATCH 1/2] Change old system name 'GIT' to 'Git' Thomas Ackermann
2013-01-20 21:08 ` Junio C Hamano
2013-01-21 18:36 ` [PATCH v2 0/6] GIT, Git, git Thomas Ackermann
2013-01-21 19:56   ` Junio C Hamano
2013-01-21 20:01     ` Junio C Hamano
2013-01-21 18:38 ` [PATCH v2 1/6] Change old system name 'GIT' to 'Git' Thomas Ackermann
2013-01-21 18:40 ` [PATCH v2 2/6] Change 'git' to 'Git' whenever the whole system is referred to #1 Thomas Ackermann
2013-01-21 18:51 ` Aw: [PATCH v2 0/6] GIT, Git, git Thomas Ackermann
2013-01-21 19:12 ` [PATCH v3 " Thomas Ackermann
2013-01-21 19:16 ` [PATCH v3 1/6] Change old system name 'GIT' to 'Git' Thomas Ackermann
2013-01-22  0:39   ` Junio C Hamano
2013-01-22  9:44   ` Aw: " Thomas Ackermann
2013-01-22 16:45     ` Junio C Hamano
2013-01-21 19:17 ` [PATCH v3 2/6] Change 'git' to 'Git' whenever the whole system is referred to #1 Thomas Ackermann
2013-01-22  0:41   ` Junio C Hamano
2013-01-22 23:48   ` Junio C Hamano
2013-01-23  0:19     ` Junio C Hamano
2013-01-23  2:24       ` Junio C Hamano
2013-01-23  2:32       ` Junio C Hamano
2013-01-21 19:19 ` [PATCH v3 3/6] Change 'git' to 'Git' whenever the whole system is referred to #2 Thomas Ackermann
2013-01-23  0:53   ` Junio C Hamano
2013-01-23  2:48     ` Junio C Hamano
2013-01-23  3:44   ` David Aguilar
2013-01-23  4:17     ` Junio C Hamano
2013-01-23  8:58     ` Aw: " Thomas Ackermann
2013-02-01  0:46       ` Junio C Hamano
2013-02-01 18:04       ` Aw: " Thomas Ackermann
2013-02-01 18:37         ` Junio C Hamano
2013-02-01 18:06       ` [PATCH 1/6] fixup! fixup! " Thomas Ackermann
2013-02-01 18:07       ` [PATCH 2/6] fixup! fixup! fixup! Change 'git' to 'Git' whenever the whole system is referred to #1 Thomas Ackermann
2013-02-01 19:43         ` Jonathan Nieder
2013-02-01 20:16           ` Junio C Hamano
2013-02-01 18:08       ` [PATCH 3/6] fixup! Documentation: avoid poor-man's small caps Thomas Ackermann
2013-02-01 18:44         ` Junio C Hamano
2013-02-01 18:10       ` [PATCH 4/6] Fix places where 'Git' should be 'git Thomas Ackermann
2013-02-01 18:11       ` [PATCH 5/6] Add a description for 'gitfile' to glossary Thomas Ackermann
2013-02-01 18:41         ` Junio C Hamano
2013-02-01 19:26           ` Junio C Hamano
2013-02-01 19:46             ` Jonathan Nieder
2013-02-01 18:12       ` [PATCH 6/6] Use consistent links for User Manual and Everyday Git; Fix a quoting error Thomas Ackermann
2013-02-01 18:43         ` Junio C Hamano
2013-02-01 19:51         ` Jonathan Nieder [this message]
2013-02-01 20:17           ` Junio C Hamano
2013-02-01 20:25         ` Aw: " Thomas Ackermann
2013-01-21 19:21 ` [PATCH v3 4/6] Change 'git' to 'Git' whenever the whole system is referred to #3 Thomas Ackermann
2013-01-23  2:49   ` Junio C Hamano
2013-01-21 19:22 ` [PATCH v3 5/6] Change 'git' to 'Git' whenever the whole system is referred to #4 Thomas Ackermann
2013-01-23  3:16   ` Junio C Hamano
2013-01-21 19:24 ` [PATCH v3 6/6] Add rule for when to use 'git' and when to use 'Git' Thomas Ackermann

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=20130201195140.GE12368@google.com \
    --to=jrnieder@gmail.com \
    --cc=davvid@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=th.acker@arcor.de \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.