mirror of
https://github.com/git/git.git
synced 2024-12-01 14:03:34 +08:00
779a206632
The "highlight" binary can, in some cases, determine the language type by the means of file contents, for example the shebang in the first line for some scripting languages. Make use of this autodetection for files which syntax is not known by gitweb. In that case, pass the blob contents to "highlight --force"; the parameter is needed to make it always generate HTML output (which includes HTML-escaping). Although we now run highlight on files which do not end up highlighted, performance is virtually unaffected because when we call highlight, it is used for escaping HTML. In the case that highlight is used, gitweb calls sanitize() instead of esc_html(), and the latter is significantly slower (it does more, being roughly a superset of sanitize()). Simple benchmark comparing performance of 'blob' view of files without syntax highlighting in gitweb before and after this change indicates ±1% difference in request time for all file types. Benchmark was performed on local instance on Debian, using Apache/2.4.23 web server and CGI. Document the feature and improve syntax highlight documentation, add test to ensure gitweb doesn't crash when language detection is used. Signed-off-by: Ian Kelling <ian@iankelling.org> Acked-by: Jakub Narębski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> |
||
|---|---|---|
| .. | ||
| static | ||
| gitweb.perl | ||
| INSTALL | ||
| Makefile | ||
| README | ||
GIT web Interface ================= From the git version 1.4.0 gitweb is bundled with git. Build time gitweb configuration ------------------------------- There are many configuration variables which affect building gitweb (among others creating gitweb.cgi out of gitweb.perl by replacing placeholders such as `++GIT_BINDIR++` by their build-time values). Building and installing gitweb is described in gitweb's INSTALL file (in 'gitweb/INSTALL'). Runtime gitweb configuration ---------------------------- Gitweb obtains configuration data from the following sources in the following order: 1. built-in values (some set during build stage), 2. common system-wide configuration file (`GITWEB_CONFIG_COMMON`, defaults to '/etc/gitweb-common.conf'), 3. either per-instance configuration file (`GITWEB_CONFIG`, defaults to 'gitweb_config.perl' in the same directory as the installed gitweb), or if it does not exists then system-wide configuration file (`GITWEB_CONFIG_SYSTEM`, defaults to '/etc/gitweb.conf'). Values obtained in later configuration files override values obtained earlier in above sequence. You can read defaults in system-wide GITWEB_CONFIG_SYSTEM from GITWEB_CONFIG by adding read_config_file($GITWEB_CONFIG_SYSTEM); at very beginning of per-instance GITWEB_CONFIG file. In this case settings in said per-instance file will override settings from system-wide configuration file. Note that read_config_file checks itself that the $GITWEB_CONFIG_SYSTEM file exists. The most notable thing that is not configurable at compile time are the optional features, stored in the '%features' variable. Ultimate description on how to reconfigure the default features setting in your `GITWEB_CONFIG` or per-project in `project.git/config` can be found as comments inside 'gitweb.cgi'. See also gitweb.conf(5) manpage. Web server configuration ------------------------ Gitweb can be run as CGI script, as legacy mod_perl application (using ModPerl::Registry), and as FastCGI script. You can find some simple examples in "Example web server configuration" section in INSTALL file for gitweb (in gitweb/INSTALL). See "Webserver configuration" and "Advanced web server setup" sections in gitweb(1) manpage. AUTHORS ------- Originally written by: Kay Sievers <kay.sievers@vrfy.org> Any comment/question/concern to: Git mailing list <git@vger.kernel.org>