[PATCH] user-manual: add addition gitweb information

[PATCH] user-manual: add addition gitweb information

[Stephen P. Smith]

Rework the section on gitweb to add information about the cgi script
and the instaweb command.

Signed-off-by: Stephen P. Smith <ischis2@cox.net>
---
 Documentation/user-manual.txt | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 1c790ac..72fb11e 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -2125,8 +2125,18 @@ Allowing web browsing of a repository
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The gitweb cgi script provides users an easy way to browse your
-project's files and history without having to install Git; see the file
-gitweb/INSTALL in the Git source tree for instructions on setting it up.
+project's files and history without having to install Git. The script
+enables the user to browse the repository revisions, file contents and
+logs. Features like RSS/Atom feeds and blame/annotation details may
+optionally be enabled.
+
+The linkgit:git-instaweb[1] command provides an simple way to start
+browsing the repository. The defualt server when using instaweb is
+lighttpd.
+
+See the file gitweb/INSTALL in the Git source tree and
+linkgit:gitweb[1] for instructions on details setting up a permament
+installation with a CGI or Perl capable server.
 
 [[sharing-development-examples]]
 Examples
@@ -4651,8 +4661,6 @@ documentation.
 Add a section on working with other version control systems, including
 CVS, Subversion, and just imports of series of release tarballs.
 
-More details on gitweb?
-
 Write a chapter on using plumbing and writing scripts.
 
 Alternates, clone -reference, etc.
-- 
2.7.0-rc2

Re: [PATCH] user-manual: add addition gitweb information

[Junio C Hamano]

"Stephen P. Smith" <ischis2@cox.net> writes:

>  The gitweb cgi script provides users an easy way to browse your
> -project's files and history without having to install Git; see the file
> -gitweb/INSTALL in the Git source tree for instructions on setting it up.
> +project's files and history without having to install Git. The script
> +enables the user to browse the repository revisions, file contents and
> +logs. Features like RSS/Atom feeds and blame/annotation details may
> +optionally be enabled.

Isn't "browse the revisions, file contents and logs" saying the same
thing as "browse your project's files and history"?  Mention of the
additional features in the last sentence is a very good thing to
have here.

> +The linkgit:git-instaweb[1] command provides an simple way to start
> +browsing the repository.

s/an simple/a simple/;

"... a simple way to start browsing the repository using gitweb",
perhaps?  What's notable about "instaweb" is that it talks with an
on-demand instance of "gitweb" and that is the only reason why we
may want to mention it together with "gitweb".  There are other
repository browsers (like "tig") that do not talk with a local
"gitweb", and we are not intersted in mentioning them all here.

> The defualt server when using instaweb is
> +lighttpd.

s/defualt/default/;

> +See the file gitweb/INSTALL in the Git source tree and
> +linkgit:gitweb[1] for instructions on details setting up a permament
> +installation with a CGI or Perl capable server.
>  
>  [[sharing-development-examples]]
>  Examples
> @@ -4651,8 +4661,6 @@ documentation.
>  Add a section on working with other version control systems, including
>  CVS, Subversion, and just imports of series of release tarballs.
>  
> -More details on gitweb?
> -
>  Write a chapter on using plumbing and writing scripts.
>  
>  Alternates, clone -reference, etc.

Other than that, looks good to me.

Thanks.

[PATCH V2] user-manual: add addition gitweb information

[Stephen P. Smith]

Rework the section on gitweb to add information about the cgi script
and the instaweb command.

Signed-off-by: Stephen P. Smith <ischis2@cox.net>
---

Notes:
    Removed wording duplication in the first paragraph.
    
    Added explicit gitweb reference with regard to instaweb.
    
    Fixed two spelling errors.

 Documentation/user-manual.txt | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 1c790ac..226b972 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -2125,8 +2125,17 @@ Allowing web browsing of a repository
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The gitweb cgi script provides users an easy way to browse your
-project's files and history without having to install Git; see the file
-gitweb/INSTALL in the Git source tree for instructions on setting it up.
+project's revisions, file contents and logs without having to install
+Git. Features like RSS/Atom feeds and blame/annotation details may
+optionally be enabled.
+
+The linkgit:git-instaweb[1] command provides a simple way to start
+browsing the repository using gitweb. The default server when using
+instaweb is lighttpd.
+
+See the file gitweb/INSTALL in the Git source tree and
+linkgit:gitweb[1] for instructions on details setting up a permament
+installation with a CGI or Perl capable server.
 
 [[sharing-development-examples]]
 Examples
@@ -4651,8 +4660,6 @@ documentation.
 Add a section on working with other version control systems, including
 CVS, Subversion, and just imports of series of release tarballs.
 
-More details on gitweb?
-
 Write a chapter on using plumbing and writing scripts.
 
 Alternates, clone -reference, etc.
-- 
2.7.0-rc2

Re: [PATCH V2] user-manual: add addition gitweb information

[Junio C Hamano]

"Stephen P. Smith" <ischis2@cox.net> writes:

>  The gitweb cgi script provides users an easy way to browse your
> -project's files and history without having to install Git; see the file
> -gitweb/INSTALL in the Git source tree for instructions on setting it up.
> +project's revisions, file contents and logs without having to install
> +Git. Features like RSS/Atom feeds and blame/annotation details may

Thanks.  Was there a reason to rewrite "files and history" into
"revisions, file contents and logs"?  The words "revisions" and
"logs" both refer to the same thing and "history" is a good word for
it already, so I am puzzled.  No strong objection, though...

> +optionally be enabled.
> +
> +The linkgit:git-instaweb[1] command provides a simple way to start
> +browsing the repository using gitweb. The default server when using
> +instaweb is lighttpd.
> +
> +See the file gitweb/INSTALL in the Git source tree and
> +linkgit:gitweb[1] for instructions on details setting up a permament
> +installation with a CGI or Perl capable server.
>  
>  [[sharing-development-examples]]
>  Examples
> @@ -4651,8 +4660,6 @@ documentation.
>  Add a section on working with other version control systems, including
>  CVS, Subversion, and just imports of series of release tarballs.
>  
> -More details on gitweb?
> -
>  Write a chapter on using plumbing and writing scripts.
>  
>  Alternates, clone -reference, etc.

Re: [PATCH V2] user-manual: add addition gitweb information

[Stephen & Linda Smith]

On Wednesday, December 30, 2015 03:29:09 PM Junio C Hamano wrote:
> "Stephen P. Smith" <ischis2@cox.net> writes:
> 
> >  The gitweb cgi script provides users an easy way to browse your
> > -project's files and history without having to install Git; see the file
> > -gitweb/INSTALL in the Git source tree for instructions on setting it up.
> > +project's revisions, file contents and logs without having to install
> > +Git. Features like RSS/Atom feeds and blame/annotation details may
> 
> Thanks.  Was there a reason to rewrite "files and history" into
> "revisions, file contents and logs"?  The words "revisions" and
> "logs" both refer to the same thing and "history" is a good word for
> it already, so I am puzzled.  No strong objection, though...
> 

"revisions, file contents and logs was in the second sentence of the first patch.
"files and history" was in the first sentence of the first patch.

When I was getting rid of the duplication I decided that "revisions, file contents and logs".   
As a secondary reason that is the wording in gitweb.txt.

Re: [PATCH V2] user-manual: add addition gitweb information

[Stephen & Linda Smith]

On Wednesday, December 30, 2015 03:29:09 PM Junio C Hamano wrote:
 > "Stephen P. Smith" <ischis2@cox.net> writes:
 > 
 > >  The gitweb cgi script provides users an easy way to browse your
 > > -project's files and history without having to install Git; see the file
 > > -gitweb/INSTALL in the Git source tree for instructions on setting it up.
 > > +project's revisions, file contents and logs without having to install
 > > +Git. Features like RSS/Atom feeds and blame/annotation details may
 > 
 > Thanks.  Was there a reason to rewrite "files and history" into
 > "revisions, file contents and logs"?  The words "revisions" and
 > "logs" both refer to the same thing and "history" is a good word for
 > it already, so I am puzzled.  No strong objection, though...
 > 

[Re-worded my explanation.]
 
"revisions, file contents and logs was in the second sentence of the first patch.
"files and history" was in the first sentence of the first patch.

When I was getting rid of the duplication I decided that "revisions, file contents 
and logs" was a little more explicit and so decided to keep that wording.

As a secondary reason that is the wording in gitweb.txt.

Re: [PATCH V2] user-manual: add addition gitweb information

[Junio C Hamano]

Stephen & Linda Smith <ischis2@cox.net> writes:

> [Re-worded my explanation.]
>  
> "revisions, file contents and logs was in the second sentence of the first patch.
> "files and history" was in the first sentence of the first patch.
>
> When I was getting rid of the duplication I decided that "revisions, file contents 
> and logs" was a little more explicit and so decided to keep that wording.
>
> As a secondary reason that is the wording in gitweb.txt.

Makes sense; thanks.