Re: [PATCH 6/6] Use consistent links for User Manual and Everyday Git; Fix a quoting error
- From
Jonathan Nieder <jrnieder@gmail.com>
- Date
- Feb 1, 2013, 19:51 UTC
- Message-ID
- <20130201195140.GE12368@google.com>
- In-Reply-To
- <549641245.1090170.1359742373184.JavaMail.ngmail@webmail18.arcor-online.net>
Thomas Ackermann wrote:
Show 9 quoted lines
> --- 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.
[...]
Show 8 quoted lines
> --- 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.
[...]
Show 9 quoted lines
> --- 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'.
[...]
Show 8 quoted lines
> --- 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