On 18 April 2018 at 22:56, Todd Zullinger <tmz@xxxxxxxxx> wrote: > Tangentially (and I don't know if it's worth fixing), while > poking around the documentation which includes urls.txt I > noticed that git-clone.txt refers readers to the "URLS > section below" when the name of the section is "GIT URLS". > > I doubt any readers would be confused, but it would be > consistent with the other files which include urls.txt to > use "GIT URLS" as the referenced section name. > > -- >& -- > Subject: [PATCH] doc/clone: update caption for GIT URLS cross-reference > > The description of the <repository> argument directs readers to "See the > URLS section below". When generating HTML this becomes a link to the > "GIT URLS" section. When reading the man page in a terminal, the > caption is slightly misleading. Use "GIT URLS" as the caption to avoid > an confusion. s/an/any/? > > The man page produced by asciidoc doesn't include hyperlinks. The > description of the <repository> argument simply > Abandoned first attempt at log message? ;-) > Signed-off-by: Todd Zullinger <tmz@xxxxxxxxx> > --- > Documentation/git-clone.txt | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt > index 42ca7b5095..b844b9957c 100644 > --- a/Documentation/git-clone.txt > +++ b/Documentation/git-clone.txt > @@ -260,7 +260,7 @@ or `--mirror` is given) > > <repository>:: > The (possibly remote) repository to clone from. See the > - <<URLS,URLS>> section below for more information on specifying > + <<URLS,GIT URLS>> section below for more information on specifying > repositories. Indeed. Matches urls.txt and the others who refer there. Martin
