mirror of
https://github.com/git/git
synced 2024-10-30 04:01:21 +00:00
0e1a85ca75
According to the HTML Standard FAQ: “What is the DOCTYPE for modern HTML documents? In text/html documents: <!DOCTYPE html> In documents delivered with an XML media type: no DOCTYPE is required and its use is generally unnecessary. However, you may use one if you want (see the following question). Note that the above is well-formed XML.” Source: [1] Gitweb uses an XHTML 1.0 DOCTYPE: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> While that DOCTYPE is still valid [2], it has several disadvantages: 1. It’s misleading. If an XML parser uses the DTD at the given link, then the entities and ⋅ won’t get declared. Instead, the parser has to use a DTD from the HTML Standard that has nothing to do with XHTML 1.0 [2]. 2. It’s obsolete. XHTML 1.0 was last revised in 2002 and was superseded in 2018 [3]. 3. It’s unreliable. Gitweb uses and ⋅ but lets an external file define them. “[…U]using entity references for characters in XML documents is unsafe if they are defined in an external file (except for <, >, &, ", and ').” [4] [1]: <https://github.com/whatwg/html/blob/main/FAQ.md#what-is-the-doctype-for-modern-html-documents> [2]: <https://html.spec.whatwg.org/multipage/xhtml.html#parsing-xhtml-documents> [3]: <https://www.w3.org/TR/xhtml1/#xhtml> [4]: <https://html.spec.whatwg.org/multipage/xhtml.html#writing-xhtml-documents> Signed-off-by: Jason Yundt <jason@jasonyundt.email> 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>