[PATCH] Mention html doc location http://www.kernel.org in DESCRIPTION

Jari Aalto· Apr 30, 2007, 11:21 UTC · lore

Signed-off-by: Jari Aalto <jari.aalto@cante.net>
---

 While reading the manual page under console, the page is rendered
 like below. The problem is than REFERENCES do not include canonical
 URL to the root where to reach the mentioned pages.

    DESCRIPTION

       Git is a fast, scalable, distributed revision control system
       with an unusually rich command set that provides both
       high-level operations and full access to internals.

       See this [1]tutorial to get started, then see [2]Everyday Git
       for a useful minimum set of

       [...]

    REFERENCES
       1. tutorial
          tutorial.html

 Documentation/git.txt |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

Show changes to Documentation/git.txt +3 −1

diff --git a/Documentation/git.txt b/Documentation/git.txt
index c5d02da..c3e1afe 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -18,7 +18,7 @@ Git is a fast, scalable, distributed revision control system with an
 unusually rich command set that provides both high-level operations
 and full access to internals.
 
-See this link:tutorial.html[tutorial] to get started, then see
+See[*] link:tutorial.html[tutorial] to get started, then see
 link:everyday.html[Everyday Git] for a useful minimum set of commands, and
 "man git-commandname" for documentation of each command.  CVS users may
 also want to read link:cvs-migration.html[CVS migration].
@@ -29,6 +29,8 @@ in a coherent way to git enlightenment ;-).
 The COMMAND is either a name of a Git command (see below) or an alias
 as defined in the configuration file (see gitlink:git-config[1]).
 
+[*] http://www.kernel.org/pub/software/scm/git/docs/
+
 ifdef::stalenotes[]
 [NOTE]
 ============

-- 
1.5.1.2.GIT

Junio C Hamano· Apr 30, 2007, 23:44 UTC · re: Jari Aalto · lore

Re: [PATCH] Mention html doc location http://www.kernel.org in DESCRIPTION

Jari Aalto <jari.aalto@cante.net> writes:

Show 19 quoted lines

> diff --git a/Documentation/git.txt b/Documentation/git.txt
> index c5d02da..c3e1afe 100644
> --- a/Documentation/git.txt
> +++ b/Documentation/git.txt
> @@ -18,7 +18,7 @@ Git is a fast, scalable, distributed revision control system with an
>  unusually rich command set that provides both high-level operations
>  and full access to internals.
>  
> -See this link:tutorial.html[tutorial] to get started, then see
> +See[*] link:tutorial.html[tutorial] to get started, then see
>  link:everyday.html[Everyday Git] for a useful minimum set of commands, and
>  "man git-commandname" for documentation of each command.  CVS users may
>  also want to read link:cvs-migration.html[CVS migration].
> @@ -29,6 +29,8 @@ in a coherent way to git enlightenment ;-).
>  The COMMAND is either a name of a Git command (see below) or an alias
>  as defined in the configuration file (see gitlink:git-config[1]).
>  
> +[*] http://www.kernel.org/pub/software/scm/git/docs/
> +

This may look Ok in ascii version of the manpage, but looks quite suboptimal in its HTML rendition. I do not know how bad it would be if the manpage is printed (i.e. troff).

I'll replace with this.

-- >8 --
From: Jari Aalto <jari.aalto@cante.net>
Date: Mon, 30 Apr 2007 14:21:38 +0300
Subject: [PATCH] git.7: Mention preformatted html doc location

Signed-off-by: Jari Aalto <jari.aalto@cante.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
---
 Documentation/git.txt |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

Show changes to Documentation/git.txt +4 −0

diff --git a/Documentation/git.txt b/Documentation/git.txt
index c81162e..aa65802 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -29,6 +29,10 @@ in a coherent way to git enlightenment ;-).
 The COMMAND is either a name of a Git command (see below) or an alias
 as defined in the configuration file (see gitlink:git-config[1]).
 
+Formatted and hyperlinked version of the latest git
+documentation can be viewed at
+`http://www.kernel.org/pub/software/scm/git/docs/`.
+
 ifdef::stalenotes[]
 [NOTE]
 ============

-- 
1.5.2.rc0.781.g5868

patchMention html doc location http://www.kernel.org in DESCRIPTION