git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[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
Previous: Martin Ågren
Message 12 of 12 in “man page for "git remote set-url" seems confusing/contradictory”
  1. Robert P. J. DayApr 16, 2018
  2. Andreas SchwabApr 16, 2018
  3. Robert P. J. DayApr 16, 2018
  4. Jacob KellerApr 16, 2018
  5. Junio C HamanoApr 16, 2018
  6. Jacob KellerApr 17, 2018
  7. Robert P. J. DayApr 17, 2018
  8. Jacob KellerApr 17, 2018
  9. Junio C HamanoApr 18, 2018
  10. Todd ZullingerApr 18, 2018
  11. Martin ÅgrenApr 19, 2018
  12. doc/clone: update caption for GIT URLS cross-referenceTodd Zullinger, Apr 19, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.