From: Jakub Narebski <jnareb@gmail.com>
Date: Tue, 4 Aug 2009 15:54:32 +0000 (+0200)
Subject: gitweb/README: Document $base_url
X-Git-Tag: v1.6.4.1~17
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=46068383aa825dfe9026f9255cea07da07e06253;p=git.git

gitweb/README: Document $base_url

Signed-off-by: Jakub Narebski <jnareb@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/gitweb/README b/gitweb/README
index 9056d1e09..66c6a9391 100644
--- a/gitweb/README
+++ b/gitweb/README
@@ -165,6 +165,12 @@ not include variables usually directly set during build):
    Full URL and absolute URL of gitweb script;
    in earlier versions of gitweb you might have need to set those
    variables, now there should be no need to do it.
+ * $base_url
+   Base URL for relative URLs in pages generated by gitweb,
+   (e.g. $logo, $favicon, @stylesheets if they are relative URLs),
+   needed and used only for URLs with nonempty PATH_INFO via
+   <base href="$base_url>.  Usually gitweb sets its value correctly,
+   and there is no need to set this variable, e.g. to $my_uri or "/".
  * $home_link
    Target of the home link on top of all pages (the first part of view
    "breadcrumbs").  By default set to absolute URI of a page ($my_uri).