[PATCHv5 5/6] gitweb: add documentation to INSTALL regarding gitweb.js

[PATCHv5 5/6] gitweb: add documentation to INSTALL regarding gitweb.js

[Mark Rada]

This patch updates gitweb/INSTALL to mention gitweb.js, including
JavaScript minification support.

Signed-off-by: Mark Rada <marada@uwaterloo.ca>

---

Changes since v4:
	- Compacted the point about minification into CSS
	  point about minification

 gitweb/INSTALL |   23 +++++++++++++----------
 1 files changed, 13 insertions(+), 10 deletions(-)

diff --git a/gitweb/INSTALL b/gitweb/INSTALL
index b75a90b..a79a183 100644
--- a/gitweb/INSTALL
+++ b/gitweb/INSTALL
@@ -3,8 +3,9 @@ GIT web Interface (gitweb) Installation
 
 First you have to generate gitweb.cgi from gitweb.perl using
 "make gitweb/gitweb.cgi", then copy appropriate files (gitweb.cgi,
-gitweb.css, git-logo.png and git-favicon.png) to their destination.
-For example if git was (or is) installed with /usr prefix, you can do
+gitweb.js, gitweb.css, git-logo.png and git-favicon.png) to their
+destination. For example if git was (or is) installed with /usr prefix,
+you can do
 
 	$ make prefix=/usr gitweb/gitweb.cgi  ;# as yourself
 	# cp gitweb/git* /var/www/cgi-bin/    ;# as root
@@ -62,14 +63,15 @@ file for gitweb (in gitweb/README).
   a suggestion).
 
 - You can control where gitweb tries to find its main CSS style file,
-  its favicon and logo with the GITWEB_CSS, GITWEB_FAVICON and GITWEB_LOGO
-  build configuration variables. By default gitweb tries to find them
-  in the same directory as gitweb.cgi script.
+  its JavaScript file, its favicon and logo with the GITWEB_CSS, GITWEB_JS
+  GITWEB_FAVICON and GITWEB_LOGO build configuration variables. By default
+  gitweb tries to find them in the same directory as gitweb.cgi script.
 
-- You can optionally generate a minified version of gitweb.css by defining
-  the CSSMIN build configuration variable. By default the non-minified
-  version of gitweb.css will be used. NOTE: if you enable this option,
-  substitute gitweb.min.css for all uses of gitweb.css in the help files.
+- You can optionally generate minified versions of gitweb.js and gitweb.css
+  by defining the JSMIN and CSSMIN build configuration variables. By default
+  the non-minified versions will be used. NOTE: if you enable this option,
+  substitute gitweb.min.js and gitweb.min.css for all uses of gitweb.js and
+  gitweb.css in the help files.
 
 Build example
 ~~~~~~~~~~~~~
@@ -79,13 +81,14 @@ Build example
   we want to display are under /home/local/scm, you can do
 
 	make GITWEB_PROJECTROOT="/home/local/scm" \
+             GITWEB_JS="/gitweb/gitweb.js" \
 	     GITWEB_CSS="/gitweb/gitweb.css" \
 	     GITWEB_LOGO="/gitweb/git-logo.png" \
 	     GITWEB_FAVICON="/gitweb/git-favicon.png" \
 	     bindir=/usr/local/bin \
 	     gitweb/gitweb.cgi
 
-	cp -fv ~/git/gitweb/gitweb.{cgi,css} \
+	cp -fv ~/git/gitweb/gitweb.{cgi,js,css} \
 	       ~/git/gitweb/git-{favicon,logo}.png \
 	     /var/www/cgi-bin/gitweb/
 
-- 
1.7.0.3.436.g45b2d

Re: [PATCHv5 5/6] gitweb: add documentation to INSTALL regarding gitweb.js

[Jakub Narebski]

On Thu, 1 Apr 2010, Mark Rada wrote:

> This patch updates gitweb/INSTALL to mention gitweb.js, including
> JavaScript minification support.
> 
> Signed-off-by: Mark Rada <marada@uwaterloo.ca>

Thanks for this writeup.

For what it is worth:
Acked-by: Jakub Narebski <jnareb@gmail.com>
 
> ---
> 
> Changes since v4:
> 	- Compacted the point about minification into CSS
> 	  point about minification

Nice to have differences from previous version described in 
comments...

> 
>  gitweb/INSTALL |   23 +++++++++++++----------
>  1 files changed, 13 insertions(+), 10 deletions(-)

This change migh have been a bit smaller without accompanying
rewrapping of affected paragraphs, but on the other hand it would
leave gitweb/INSTALL less readable.
 

> @@ -79,13 +81,14 @@ Build example
>    we want to display are under /home/local/scm, you can do
>  
>  	make GITWEB_PROJECTROOT="/home/local/scm" \
> +             GITWEB_JS="/gitweb/gitweb.js" \

Minor nit: other lines use TAB + 5 x SPACE, so it should read:

  +	     GITWEB_JS="/gitweb/gitweb.js" \

   -----^^^^^

>  	     GITWEB_CSS="/gitweb/gitweb.css" \
>  	     GITWEB_LOGO="/gitweb/git-logo.png" \
>  	     GITWEB_FAVICON="/gitweb/git-favicon.png" \
>  	     bindir=/usr/local/bin \
>  	     gitweb/gitweb.cgi

-- 
Jakub Narebski
Poland