gitweb: Improve comments about gitweb features configuration
Signed-off-by: Jakub Narebski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
Jakub Narebski committed
Aug 26, 2006 at 19:14 UTC
17848fc67cf466b805f35608230f4df898943ec1
1 file changed
+16
-9
gitweb/gitweb.perl
+16
-9
@@ -67,9 +67,16 @@ our $mimetypes_file = undef;
67
# You define site-wide feature defaults here; override them with
68
# $GITWEB_CONFIG as necessary.
69
our %feature = (
70
- # feature => {'sub' => feature-sub, 'override' => allow-override, 'default' => [ default options...]
71
- # if feature is overridable, feature-sub will be called with default options;
72
- # return value indicates if to enable specified feature
70
+ # feature => {
71
+ # 'sub' => feature-sub (subroutine),
72
+ # 'override' => allow-override (boolean),
73
+ # 'default' => [ default options...] (array reference)}
74
+ #
75
+ # if feature is overridable (it means that allow-override has true value,
76
+ # then feature-sub will be called with default options as parameters;
77
+ # return value of feature-sub indicates if to enable specified feature
78
+ #
79
+ # use gitweb_check_feature(<feature>) to check if <feature> is enabled
80
81
'blame' => {
82
'sub' => \&feature_blame,
@@ -95,9 +102,9 @@ sub gitweb_check_feature {
102
}
103
104
# To enable system wide have in $GITWEB_CONFIG
98
-# $feature{'blame'}{'default'} = [1];
99
-# To have project specific config enable override in $GITWEB_CONFIG
100
-# $feature{'blame'}{'override'} = 1;
105
+# $feature{'blame'}{'default'} = [1];
106
+# To have project specific config enable override in $GITWEB_CONFIG
107
+# $feature{'blame'}{'override'} = 1;
108
# and in project config gitweb.blame = 0|1;
109
110
sub feature_blame {
@@ -113,9 +120,9 @@ sub feature_blame {
120
}
121
122
# To disable system wide have in $GITWEB_CONFIG
116
-# $feature{'snapshot'}{'default'} = [undef];
117
-# To have project specific config enable override in $GITWEB_CONFIG
118
-# $feature{'blame'}{'override'} = 1;
123
+# $feature{'snapshot'}{'default'} = [undef];
124
+# To have project specific config enable override in $GITWEB_CONFIG
125
+# $feature{'blame'}{'override'} = 1;
126
# and in project config gitweb.snapshot = none|gzip|bzip2
127
128
sub feature_snapshot {