From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mark Rada Subject: [PATCHv5 5/6] gitweb: add documentation to INSTALL regarding gitweb.js Date: Thu, 01 Apr 2010 01:37:01 -0400 Message-ID: <4BB430FD.3050306@mailservices.uwaterloo.ca> Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Cc: Junio C Hamano , Jakub Narebski To: git@vger.kernel.org X-From: git-owner@vger.kernel.org Thu Apr 01 07:38:33 2010 Return-path: Envelope-to: gcvg-git-2@lo.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1NxD6u-0003al-7B for gcvg-git-2@lo.gmane.org; Thu, 01 Apr 2010 07:38:32 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753036Ab0DAFi1 (ORCPT ); Thu, 1 Apr 2010 01:38:27 -0400 Received: from mailservices.uwaterloo.ca ([129.97.128.141]:51995 "EHLO mailchk-m04.uwaterloo.ca" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1752969Ab0DAFiZ (ORCPT ); Thu, 1 Apr 2010 01:38:25 -0400 Received: from karakura.local (bas1-toronto01-1177657512.dsl.bell.ca [70.49.160.168]) (authenticated bits=0) by mailchk-m04.uwaterloo.ca (8.13.8/8.13.8) with ESMTP id o315b1pH026522 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Thu, 1 Apr 2010 01:37:03 -0400 User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.1.8) Gecko/20100227 Thunderbird/3.0.3 X-UUID: 65f7c3b2-812e-4918-ac5b-1472181adeec X-Miltered: at mailchk-m04 with ID 4BB430FD.001 by Joe's j-chkmail (http://j-chkmail.ensmp.fr)! X-Virus-Scanned: clamav-milter 0.95.2 at mailchk-m04 X-Virus-Status: Clean X-Greylist: Sender succeeded SMTP AUTH authentication, not delayed by milter-greylist-3.0 (mailchk-m04.uwaterloo.ca [129.97.128.141]); Thu, 01 Apr 2010 01:37:04 -0400 (EDT) Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: This patch updates gitweb/INSTALL to mention gitweb.js, including JavaScript minification support. Signed-off-by: Mark Rada --- 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