[PATCH] doc/clone: update caption for GIT URLS cross-reference
- From
Todd Zullinger <tmz@pobox.com>
- Date
- Apr 19, 2018, 17:32 UTC
- Message-ID
- <20180419173230.GZ29831@zaya.teonanacatl.net>
- In-Reply-To
- <CAN0heSrrpvRXGi1hzUuRqXcQCOJQcBcLWAWQKXrivx6tkxAsBw@mail.gmail.com>
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 any confusion.
Signed-off-by: Todd Zullinger <tmz@pobox.com> --- Martin Ågren wrote:
Show 10 quoted lines
> On 18 April 2018 at 22:56, Todd Zullinger <tmz@pobox.com> wrote: >> 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/?
Indeed, thanks.
>> The man page produced by asciidoc doesn't include hyperlinks. The >> description of the <repository> argument simply > > Abandoned first attempt at log message? ;-)
That or it was when a squirrel ran by my window. ;)
Thanks for catching both of these mistakes.
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. <directory>::
--
2.17.0
--
Todd
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Whenever you find yourself on the side of the majority, it is time to
pause and reflect.
-- Mark Twain