[Lxr-general] [PATCH] LXR: Document GIT backend configury in template/lxr.conf

[Jan-Benedict G. <jb...@lu...>]

Hi!

This adds some description of those two variables that may be set in
conjunction with the GIT backend.

Index: templates/lxr.conf
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /cvsroot/lxr/lxr/templates/lxr.conf,v
retrieving revision 1.27
diff -u -r1.27 lxr.conf
--- templates/lxr.conf	8 Apr 2006 13:37:58 -0000	1.27
+++ templates/lxr.conf	26 Nov 2006 22:39:55 -0000
@@ -124,9 +124,23 @@
=20
 		# The name to display for this source tree
 		'sourcerootname' =3D> 'Example',
-	=09
-		# Any parameters to the source access method should be specified below
-		'sourceparams' =3D> {'cachepath' =3D> '/a/path/here'},
+
+		#
+		# Any parameters to the source access method should be specified below.
+		#
+		# BK:	'cachepath' is used for temporary files
+		# GIT:	if `do_annotations' is non-zero, the file revision that
+		# 		introduced each line is displayed.
+		# 	`do_blame' will add the author of each line to the
+		# 		output. Keep in mind that the core LXR code
+		# 		will only request author information if
+		# 		annotations are switched on, too!
+		#
+		'sourceparams' =3D> {
+			'cachepath' =3D> '/a/path/here',
+			'do_annotate' =3D> 1,
+			'do_blame'  =3D> 1,
+		},
=20
 		# The DBI identifier for the database to use
 		# For mysql, the format is dbi:mysql:dbname=3D<name>


MfG, JBG

--=20
      Jan-Benedict Glaw      jb...@lu...              +49-172-7608481
 Signature of:                            If it doesn't work, force it.
 the second  :                   If it breaks, it needed replacing anyway.