kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

gitweb: document $per_request_config better 

Global variables $my_url, $my_uri and $base_url have subtle interactions
that need to be desribed, and can be influenced most cleanly by
$per_request_config.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Acked-by: Jakub Narebski <jnareb@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Jonathan Nieder 2010-11-28 18:19:08 -06:00 committed by Junio C Hamano
parent da4b2432cc
commit b3f52a9c3a
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
gitweb/README
View File

@ -177,13 +177,15 @@ not include variables usually directly set during build):
* $my_url, $my_uri * $my_url, $my_uri
Full URL and absolute URL of gitweb script; Full URL and absolute URL of gitweb script;
in earlier versions of gitweb you might have need to set those in earlier versions of gitweb you might have need to set those
variables, now there should be no need to do it. variables, now there should be no need to do it. See
$per_request_config if you need to set them still.
* $base_url * $base_url
Base URL for relative URLs in pages generated by gitweb, Base URL for relative URLs in pages generated by gitweb,
(e.g. $logo, $favicon, @stylesheets if they are relative URLs), (e.g. $logo, $favicon, @stylesheets if they are relative URLs),
needed and used only for URLs with nonempty PATH_INFO via needed and used only for URLs with nonempty PATH_INFO via
<base href="$base_url">. Usually gitweb sets its value correctly, <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 "/". and there is no need to set this variable, e.g. to $my_uri or "/".
See $per_request_config if you need to set it anyway.
* $home_link * $home_link
Target of the home link on top of all pages (the first part of view 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). "breadcrumbs"). By default set to absolute URI of a page ($my_uri).
@ -252,7 +254,10 @@ not include variables usually directly set during build):
sub { $ENV{GL_USER} = $cgi->remote_user || "gitweb"; } sub { $ENV{GL_USER} = $cgi->remote_user || "gitweb"; }
Otherwise it is treated as boolean value: if true gitweb would process Otherwise it is treated as boolean value: if true gitweb would process
config file once per request, if false it would process config file only config file once per request, if false it would process config file only
once. The default is true. once. Note: $my_url, $my_uri, and $base_url are overwritten with
their default values before every request, so if you want to change
them, be sure to set this variable to true or a code reference effecting
the desired changes. The default is true.


Projects list file format Projects list file format
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~