[Lxr-commits] CVS: lxr/templates lxr.conf,1.27,1.28

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

Update of /cvsroot/lxr/lxr/templates
In directory sc8-pr-cvs6.sourceforge.net:/tmp/cvs-serv1252/templates

Modified Files:
	lxr.conf 
Log Message:
Update sourceparams documentation.


Index: lxr.conf
===================================================================
RCS file: /cvsroot/lxr/lxr/templates/lxr.conf,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -d -r1.27 -r1.28
--- lxr.conf	8 Apr 2006 13:37:58 -0000	1.27
+++ lxr.conf	20 Dec 2006 19:52:26 -0000	1.28
@@ -124,9 +124,23 @@
 
 		# The name to display for this source tree
 		'sourcerootname' => 'Example',
-		
-		# Any parameters to the source access method should be specified below
-		'sourceparams' => {'cachepath' => '/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' => {
+			'cachepath' => '/a/path/here',
+			'do_annotate' => 1,
+			'do_blame'  => 1,
+		},
 
 		# The DBI identifier for the database to use
 		# For mysql, the format is dbi:mysql:dbname=<name>