| Message ID | 20190515224709.2936-3-philipoakley@iee.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | accessing the git(1) help page | expand |
Philip Oakley <philipoakley@iee.org> writes: > While checking the html formatted git(1) manual page, it was noted > that the link to https://git.github.io/htmldocs/git.html was formatted > as code. Remove the backticks. Good. I just ran $ git grep '`https*://' Documentation/ to see if any hits I see are for the real URL the user may want to click on. There are some that are pointing at real sites, but I do not think users would want to clickon many of them while reading the documentation. Except perhaps for these to see what's there: Documentation/git-archimport.txt: Attempt to auto-register archives at `http://mirrors.sourcecontrol.net` Documentation/git-cvsimport.txt:* cvs2git (part of cvs2svn), `http://subversion.apache.org/`
On 16/05/2019 02:56, Junio C Hamano wrote: > Philip Oakley <philipoakley@iee.org> writes: > >> While checking the html formatted git(1) manual page, it was noted >> that the link to https://git.github.io/htmldocs/git.html was formatted >> as code. Remove the backticks. > Good. I just ran > > $ git grep '`https*://' Documentation/ > > to see if any hits I see are for the real URL the user may want to > click on. There are some that are pointing at real sites, but I do > not think users would want to clickon many of them while reading the > documentation. I'd had a quick brows and mainly found example.com ;-) Any other excepts were at the other end of the doc relative to git(1)... > > Except perhaps for these to see what's there: > > Documentation/git-archimport.txt: Attempt to auto-register archives at `http://mirrors.sourcecontrol.net` That domain is gone. Whole line should probably be removed. > Documentation/git-cvsimport.txt:* cvs2git (part of cvs2svn), `http://subversion.apache.org/` > Still there. Still updated - last news 2019-04-24. Could remove backticks. Philip
On Thu, May 16, 2019 at 12:25:47PM +0100, Philip Oakley wrote: > > Except perhaps for these to see what's there: > > > > Documentation/git-archimport.txt: Attempt to auto-register archives at `http://mirrors.sourcecontrol.net` > That domain is gone. Whole line should probably be removed. Heh, see: https://public-inbox.org/git/20170420203441.mrlwbkqinub7m225@sigill.intra.peff.net/ I left it to people who actually care about arch to clean up that line and figure out if there is some useful alternative. -Peff
On 16/05/2019 23:22, Jeff King wrote: > On Thu, May 16, 2019 at 12:25:47PM +0100, Philip Oakley wrote: > >>> Except perhaps for these to see what's there: >>> >>> Documentation/git-archimport.txt: Attempt to auto-register archives at `http://mirrors.sourcecontrol.net` >> That domain is gone. Whole line should probably be removed. > Heh, see: > > https://public-inbox.org/git/20170420203441.mrlwbkqinub7m225@sigill.intra.peff.net/ > > I left it to people who actually care about arch to clean up that line > and figure out if there is some useful alternative. > Thanks. I'll sit on my hands on that one then (i.e. do nothing).
diff --git a/Documentation/git.txt b/Documentation/git.txt index dbf92f6ac6..edcb9936b5 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -33,7 +33,8 @@ individual Git commands with "git help command". linkgit:gitcli[7] manual page gives you an overview of the command-line command syntax. A formatted and hyperlinked copy of the latest Git documentation -can be viewed at `https://git.github.io/htmldocs/git.html`. +can be viewed at https://git.github.io/htmldocs/git.html +or https://git-scm.com/docs. OPTIONS
While checking the html formatted git(1) manual page, it was noted that the link to https://git.github.io/htmldocs/git.html was formatted as code. Remove the backticks. While at it, add the https://git-scm.com/docs link which one reviewer noted had linkable section headings. Helped-by: Jeff King <peff@peff.net> Signed-off-by: Philip Oakley <philipoakley@iee.org> --- Documentation/git.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)