gitweb: Improve installation instructions in gitweb/INSTALL

PATCH In review Jakub Narebski 2 participants 5 messages Jun 15, 2016

lore

Share & tools

lore

Jakub Narebski

author

2016-06-15 22:48 UTC #0 lore raw

PATCH 1/1 gitweb: Improve installation instructions in gitweb/INSTALL

Signed-off-by Jakub Narebski <[email protected]>

---

 gitweb/INSTALL |   20 +++++++++++++++-----
 1 files changed, 15 insertions(+), 5 deletions(-)

gitweb/INSTALL +15 -5

index cbdc136..be965d2 100644
@@ -7,7 +7,9 @@ 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             ;# as yourself
-	# cp gitweb/git* /var/www/cgi-bin/    ;# as root
+	# cp gitweb/*.cgi gitweb/*.css \
+       gitweb/*.js  gitweb/*.png \
+       /var/www/cgi-bin/                ;# as root
 
 Alternatively you can use autoconf generated ./configure script to
 set up path to git binaries (via config.mak.autogen), so you can write

@@ -16,7 +18,9 @@ instead
 	$ make configure                     ;# as yourself
 	$ ./configure --prefix=/usr          ;# as yourself
 	$ make gitweb                        ;# as yourself
-	# cp gitweb/git* /var/www/cgi-bin/   ;# as root
+	# cp gitweb/*.cgi gitweb/*.css \
+       gitweb/*.js  gitweb/*.png \
+       /var/www/cgi-bin/               ;# as root
 
 The above example assumes that your web server is configured to run
 [executable] files in /var/www/cgi-bin/ as server scripts (as CGI

@@ -74,7 +78,7 @@ file for gitweb (in gitweb/README).
 Build example
 ~~~~~~~~~~~~~
 
-- To install gitweb to /var/www/cgi-bin/gitweb/ when git wrapper
+- To install gitweb to /var/www/cgi-bin/gitweb/, when git wrapper
   is installed at /usr/local/bin/git and the repositories (projects)
   we want to display are under /home/local/scm, you can do

@@ -86,10 +90,16 @@ Build example
 	     bindir=/usr/local/bin \
 	     gitweb
 
-	cp -fv ~/git/gitweb/gitweb.{cgi,js,css} \
-	       ~/git/gitweb/git-{favicon,logo}.png \
+	cp -fv gitweb/gitweb.{cgi,js,css} \
+	       gitweb/git-{favicon,logo}.png \
 	     /var/www/cgi-bin/gitweb/
 
+  The above instruction assumes that you didn't use JavaScript
+  minimizer or CSS minimizer.  If you use minimizers you need
+  to modify above instructions accordingly, which means pointing
+  GITWEB_CSS and GITWEB_JS to minified versions, and copying 
+  minified files.
+
 
 Gitweb config file
 ------------------

Jakub Narebski

author

2016-06-15 22:48 UTC #1 lore raw

PATCH 1/1 gitweb: Improve installation instructions in gitweb/INSTALL

Signed-off-by Jakub Narebski <[email protected]>

---
Fixed spaces instead of tab in one place.

 gitweb/INSTALL |   20 +++++++++++++++-----
 1 files changed, 15 insertions(+), 5 deletions(-)

gitweb/INSTALL +15 -5

index cbdc136..94ec05f 100644
@@ -7,7 +7,9 @@ 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             ;# as yourself
-	# cp gitweb/git* /var/www/cgi-bin/    ;# as root
+	# cp gitweb/*.cgi gitweb/*.css \
+	     gitweb/*.js  gitweb/*.png \
+	     /var/www/cgi-bin/                ;# as root
 
 Alternatively you can use autoconf generated ./configure script to
 set up path to git binaries (via config.mak.autogen), so you can write

@@ -16,7 +18,9 @@ instead
 	$ make configure                     ;# as yourself
 	$ ./configure --prefix=/usr          ;# as yourself
 	$ make gitweb                        ;# as yourself
-	# cp gitweb/git* /var/www/cgi-bin/   ;# as root
+	# cp gitweb/*.cgi gitweb/*.css \
+	     gitweb/*.js  gitweb/*.png \
+	     /var/www/cgi-bin/               ;# as root
 
 The above example assumes that your web server is configured to run
 [executable] files in /var/www/cgi-bin/ as server scripts (as CGI

@@ -74,7 +78,7 @@ file for gitweb (in gitweb/README).
 Build example
 ~~~~~~~~~~~~~
 
-- To install gitweb to /var/www/cgi-bin/gitweb/ when git wrapper
+- To install gitweb to /var/www/cgi-bin/gitweb/, when git wrapper
   is installed at /usr/local/bin/git and the repositories (projects)
   we want to display are under /home/local/scm, you can do

@@ -86,10 +90,16 @@ Build example
 	     bindir=/usr/local/bin \
 	     gitweb
 
-	cp -fv ~/git/gitweb/gitweb.{cgi,js,css} \
-	       ~/git/gitweb/git-{favicon,logo}.png \
+	cp -fv gitweb/gitweb.{cgi,js,css} \
+	       gitweb/git-{favicon,logo}.png \
 	     /var/www/cgi-bin/gitweb/
 
+  The above instruction assumes that you didn't use JavaScript
+  minimizer or CSS minimizer.  If you use minimizers you need
+  to modify above instructions accordingly, which means pointing
+  GITWEB_CSS and GITWEB_JS to minified versions, and copying 
+  minified files.
+
 
 Gitweb config file
 ------------------

Mark Rada

2016-06-15 22:48 UTC #2 lore raw

In reply to Jakub Narebski

gitweb/INSTALL Build example · line 102

Quoted 7 lines · Jakub Narebski

gitweb/INSTALL +6 -0

+  The above instruction assumes that you didn't use JavaScript
+  minimizer or CSS minimizer.  If you use minimizers you need
+  to modify above instructions accordingly, which means pointing
+  GITWEB_CSS and GITWEB_JS to minified versions, and copying 
+  minified files.
+

Hmm, I believe I already put a message like this in the INSTALL file. Perhaps that message should be updated, too, or removed in place of your patch.

Looks like:
67
68 - You can optionally generate minified versions of gitweb.js and gitweb.css

 69   by defining the JSMIN and CSSMIN build configuration variables. By default
 70   the non-minified versions will be used. NOTE: if you enable this option,
 71   substitute gitweb.min.js and gitweb.min.css for all uses of gitweb.js and
 72   gitweb.css in the help files.

Signature · 2 lines

Mark Rada
[email protected]

Jakub Narebski

author

2016-06-15 22:48 UTC #3 lore raw

PATCH v2 1/1 gitweb: Improve installation instructions in gitweb/INSTALL

Quoted 13 lines · Mark Rada

Review
Quoted 7 lines · Jakub Narebski
(quoted diff) +6 -0
+  The above instruction assumes that you didn't use JavaScript
+  minimizer or CSS minimizer.  If you use minimizers you need
+  to modify above instructions accordingly, which means pointing
+  GITWEB_CSS and GITWEB_JS to minified versions, and copying 
+  minified files.
+
Hmm, I believe I already put a message like this in the INSTALL file. Perhaps that message should be updated, too, or removed in place of your patch.

Quoted 7 lines

Looks like:
67
68 - You can optionally generate minified versions of gitweb.js and gitweb.css

 69   by defining the JSMIN and CSSMIN build configuration variables. By default
 70   the non-minified versions will be used. NOTE: if you enable this option,
 71   substitute gitweb.min.js and gitweb.min.css for all uses of gitweb.js and
 72   gitweb.css in the help files.

How about this then:

-- >8 --
From: Jakub Narebski <[email protected]>
Date: Tue, 27 Apr 2010 22:45:19 +0200
Subject: [PATCHv2] gitweb: Improve installation instructions in gitweb/INSTALL

Signed-off-by Jakub Narebski <[email protected]>

---
 gitweb/INSTALL |   19 ++++++++++++-------
 1 files changed, 12 insertions(+), 7 deletions(-)

gitweb/INSTALL +12 -7

index cbdc136..1bfd9aa 100644
@@ -7,7 +7,9 @@ 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             ;# as yourself
-	# cp gitweb/git* /var/www/cgi-bin/    ;# as root
+	# cp gitweb/*.cgi gitweb/*.css \
+	     gitweb/*.js  gitweb/*.png \
+	     /var/www/cgi-bin/                ;# as root
 
 Alternatively you can use autoconf generated ./configure script to
 set up path to git binaries (via config.mak.autogen), so you can write

@@ -16,7 +18,9 @@ instead
 	$ make configure                     ;# as yourself
 	$ ./configure --prefix=/usr          ;# as yourself
 	$ make gitweb                        ;# as yourself
-	# cp gitweb/git* /var/www/cgi-bin/   ;# as root
+	# cp gitweb/*.cgi gitweb/*.css \
+	     gitweb/*.js  gitweb/*.png \
+	     /var/www/cgi-bin/               ;# as root
 
 The above example assumes that your web server is configured to run
 [executable] files in /var/www/cgi-bin/ as server scripts (as CGI

@@ -74,9 +78,10 @@ file for gitweb (in gitweb/README).
 Build example
 ~~~~~~~~~~~~~
 
-- To install gitweb to /var/www/cgi-bin/gitweb/ when git wrapper
-  is installed at /usr/local/bin/git and the repositories (projects)
-  we want to display are under /home/local/scm, you can do
+- To install gitweb to /var/www/cgi-bin/gitweb/, when git wrapper
+  is installed at /usr/local/bin/git, the repositories (projects)
+  we want to display are under /home/local/scm, and you do not use
+  minifiers, you can do
 
 	make GITWEB_PROJECTROOT="/home/local/scm" \
 	     GITWEB_JS="/gitweb/gitweb.js" \

@@ -86,8 +91,8 @@ Build example
 	     bindir=/usr/local/bin \
 	     gitweb
 
-	cp -fv ~/git/gitweb/gitweb.{cgi,js,css} \
-	       ~/git/gitweb/git-{favicon,logo}.png \
+	cp -fv gitweb/gitweb.{cgi,js,css} \
+	       gitweb/git-{favicon,logo}.png \
 	     /var/www/cgi-bin/gitweb/

Signature · 1 line

1.7.0.1

Mark Rada

Acked-by on v2 1/1

2016-06-15 22:48 UTC #4 lore raw

gitweb/INSTALL file for gitweb (in gitweb/README). · line 84

Quoted 8 lines · Jakub Narebski

-- To install gitweb to /var/www/cgi-bin/gitweb/ when git wrapper

gitweb/INSTALL +4 -2

-  is installed at /usr/local/bin/git and the repositories (projects)
-  we want to display are under /home/local/scm, you can do
+- To install gitweb to /var/www/cgi-bin/gitweb/, when git wrapper
+  is installed at /usr/local/bin/git, the repositories (projects)
+  we want to display are under /home/local/scm, and you do not use
+  minifiers, you can do

To me it looks like a run on sentence, but it doesn't provide redundant information and leaves a keyword to help jump to the relevant section.

FWIW:

Acked-by Mark Rada <[email protected]>

Signature · 2 lines

Mark Rada
[email protected]