Thread: [Lxr-commits] CVS: lxr/templates datastorage.conf.part, NONE, 1.1 global.conf.part, NONE, 1.1 lxr.c
Brought to you by:
ajlittoz
From: Andre-Littoz <ajl...@us...> - 2013-01-11 12:04:31
|
Update of /cvsroot/lxr/lxr/templates In directory sfp-cvs-1.v30.ch3.sourceforge.com:/tmp/cvs-serv31377/templates Modified Files: lxr.conf lxrkernel.conf Added Files: datastorage.conf.part global.conf.part Log Message: Configuration process: part 2/5 Upgrade configuration templates lxr.conf & lxrkernel.conf changed to new LCL, using common parts global.conf.part & datastorage.conf.part --- NEW FILE: datastorage.conf.part --- #- -*- mode: perl -*- #- LXR master configuration file #- Tree configuration section #- Data storage subsection #- #- $Id: datastorage.conf.part,v 1.1 2013/01/11 12:04:27 ajlittoz Exp $ #- #- #- This file fragment is meant to be "included" to form the #- complete configuration file. #- #- #- # Data storage subsection # #- #=========================# #- #@LOG Configuring data storage # The DBI identifier for the database to use # For MySQL, the format is dbi:mysql:dbname=<name> # for Postgres, it is dbi:Pg:dbname=<name>;host=localhost # for Oracle, it is dbi:Oracle:host=localhost;sid=DEVMMS;port=1521 # for SQLite, it is dbi:SQLite:dbname=<filename> #@CASE %_dbengine% #- ----- MySQL ----- #@m: #@ IF !%_globaldb% #@ ASK --- Database name?; -2 #@ DEFINE DB_name="%A%" #@ ENDIF , 'dbname' => 'dbi:mysql:dbname=%DB_name%' #- #- ----- Oracle ----- #@o: , 'dbname' => 'dbi:Oracle:host=localhost;sid=DEVMMS;port=1521' #- #- ----- PostgreSQL ----- #@p: #@ IF !%_globaldb% #@ ASK --- Database name?; -2 #@ DEFINE DB_name="%A%" #@ ENDIF , 'dbname' => 'dbi:Pg:dbname=%DB_name%;host=localhost' #- #- ----- SQLite ----- #@s: #@ IF !%_globaldb% #@ ASK --- Database file? (e.g. /home/myself/storage.db); -2 #@ DEFINE DB_name="%A%" #@ ENDIF , 'dbname' => 'dbi:SQLite:dbname=%DB_name%' #@ENDC %_dbengine% #- #- #@IF %_dbengine% ne "s" #@ IF !%_dbuser% #@ ASK --- DB user name?; -1; ; lxr #@ DEFINE DB_tree_user="%A%" #@ ASK --- DB password?; -1; ; lxrpw #@ DEFINE DB_tree_password="%A%" , 'dbuser' => '%DB_tree_user%' , 'dbpass' => '%DB_tree_password%' #- #@ ELSEIF !%_globaldb% #@ ASK,C Do you want to override the global '%DB_user%' user name?; 2; yes,no; Y,N #@ IF %C% eq "Y" #@ ASK --- DB user name?; -1; ; lxr #@ DEFINE DB_tree_user="%A%" #@ ASK --- DB password?; -1; ; lxrpw #@ DEFINE DB_tree_password="%A%" , 'dbuser' => '%DB_tree_user%' , 'dbpass' => '%DB_tree_password%' #@ ELSE # If you need to specify the username or password for the database connection, # uncomment the following two lines # , 'dbuser' => 'lxr' # , 'dbpass' => 'lxrpw' #@ ENDIF #@ ENDIF #@ENDIF %_dbengine% ne "s" #- #- #@IF !%_dbprefix% #@ ASK --- DB table prefix?; -1; ; lxr_ #@ DEFINE DB_tbl_prefix="%A%" , 'dbprefix' => '%DB_tbl_prefix%' #- #@ELSEIF !%_globaldb% #@ ASK,C Do you want to override the global '%DB_global_prefix%' table prefix?; 2; yes,no; Y,N #@ IF %C% eq "Y" #@ ASK --- DB table prefix?; -1; ; lxr_ #@ DEFINE DB_tbl_prefix="%A%" , 'dbprefix' => '%DB_tbl_prefix%' #@ ELSE # If you need multiple lxr configurations in one database, set different table # prefixes for them. # , 'dbprefix' => 'lxr_' #@ ENDIF #@ENDIF %_dbprefix% # The following two parameters are now automatically # generated from 'glimpsedirbase' or 'swishdirbase' and # 'virtroot'. # They may nevertheless be overridden here by uncommenting # them and filling-in an appropriate absolute path. # For using glimpse, the directory to store the .glimpse files in is required # , 'glimpsedir' => '/path/to/glimpse/databases' # Location of swish-e index database files if using swish-e # , 'swishdir' => '/path/to/swish/databases' --- NEW FILE: global.conf.part --- #- -*- mode: perl -*- #- LXR master configuration file #- Global configuration section #- #- $Id: global.conf.part,v 1.1 2013/01/11 12:04:27 ajlittoz Exp $ #- #- #- This file fragment is meant to be "included" to form the #- complete configuration file. #- #- #- ################################ #- # Global configuration section # #- ################################ #- { # Auxiliary tools subsection # #============================# #@LOG Configuring auxiliary tool paths #- Place where lxr can write temporary files 'tmpdir' => '/tmp' #- Define this OR the swish-e variable depending which search engine you want to use. #- Path to glimpse executables. #- e.g.: , 'glimpsebin' => '/usr/local/bin/glimpse' #@U , 'glimpsebin' => '%glimpse%' #@U , 'glimpseindex' => '%glimpseindex%' #@U , 'glimpsedirbase' => '%glimpsedirbase%' #- Location of SWISH-E binary #- e.g.: , 'swishbin' => '/usr/local/bin/swish-e' #@U , 'swishbin' => '%swish%' #@U , 'swishdirbase' => '%swishdirbase%' #- Location of the SWISH-E.conf file , 'swishconf' => '%LXRroot%/templates/swish-e.conf' #- Path to Exuberant Ctags executable , 'ectagsbin' => '%ctags%' #- Location of the ectags.conf file , 'ectagsconf' => '%LXRroot%/templates/ectags.conf' #- Paths for CVS module , 'cvspath' => '/bin:/usr/local/bin:/usr/bin:/usr/sbin' # Computer DNS names subsection # #================================ #@LOG Configuring host name or IP (as http://...) #@ASK --- Host name?; -2 , 'host_names' => [ '%A%' #@KEEPON --- Alias name ? (hit return to stop) , '%A%' #@ENDK #- , //localhost #- , https://192.168.1.1 #- , 'http://mycomputer.outside.domain:12345' ] # HTML subsection # #=================# #@LOG Configuring HTML parameters # All paths in this subsection are relative to LXR root directory # Templates used for headers and footers , 'htmlfatal' => 'templates/html/html-fatal.html' #@MSG 'Buttons-and-menus' interface is recommended for the kernel #@MSG to avoid screen cluttering. #@ASK --- Use 'buttons-and-menus' instead of 'link' interface?; 1;yes, no; Y, N #@IF %A% eq "Y" , 'htmlhead' => 'templates/html/html-head-btn.html' #@ELSE , 'htmlhead' => 'templates/html/html-head.html' #@ENDIF , 'htmltail' => 'templates/html/html-tail.html' , 'htmldir' => 'templates/html/html-dir-indexing.html' # If you do not need the "last indexed" column in directory # display (e.g. for a stable unchanging tree), erase the # '-indexing' suffix above. , 'htmlident' => 'templates/html/html-ident.html' , 'htmlsearch' => 'templates/html/html-search-%search_engine%.html' , 'htmlconfig' => 'templates/html/html-config.html' # htmlhead and htmltail can be customised for the various # LXR operations. Just replace html by source (listing file), # sourcedir (displaying directory), diff (difference markup), # ident (identifier search), search (free-text search) # as below (which changes nothing): # , 'sourcehead' => 'templates/html/html-head.html' # , 'sourcedirhead' => 'templates/html/html-head.html' # showconfig script is a bit special since "version" has # no meaning for it. Better to wipe out the 'variables' selection # links with an adequate header: , 'showconfighead' => 'templates/html/config-head-btn-smaller.html' # Default character width of left version (for diff) , 'diffleftwidth' => 50 # Default identifier search constraint (for ident) # , 'identdefonly' => 1 # CSS style sheet , 'stylesheet' => 'templates/lxr.css' , 'alternate_stylesheet' => [ 'templates/classic.css' ] # Default character encoding , 'encoding' => 'utf-8' # File management subsection # #============================# #@LOG Configuring file subsection # Which files should be excluded from indexing (and display). , 'ignorefiles' => '^\\.|~$|\\.(o|a|orig)$|^CVS$|^core$' # Which extensions to treat as images when browsing. If a file is an image, # it is displayed. , 'graphicfile' => 'bitmap|bmp|gif|icon?|jp2|jpe?g|pjpe?g|png|svg|tiff?|xbm|xpm' # Which file extensions are associated with which icon # Below is an example using 'Oxygen' theme available with KDE # small-icons/ is a symbolic link to # /usr/share/icons/oxygen/22x22/mimetypes/ # (This location is valid for Fedora distributions, # check for others) # , 'iconfolder' => 'small-icons/' # Don't forget the final / above. # , 'icons' => # { 'c|pc' => 'text-x-csrc.png' # , 'h|hh' => 'text-x-chdr.png' # , 'c\+\+|cc|cpp|cxx' => 'text-x-c++src.png' # , 'hpp|hxx|h\+\+' => 'text-x-c++hdr.png' # , 'java' => 'text-x-java.png' # , 'js' => 'application-x-javascript.png' # , 'pl|pm|perl' => 'application-x-perl.png' # , 'php|php3|phtml' => 'application-x-php.png' # , 'py|python' => 'text-x-python.png' # , 'sh|bsh|bash|ksh|zsh' => 'text-x-script.png' # , 's?html?' => 'text-html.png' # , 'css' => 'text-css.png' # , 'pdf' => 'application-pdf.png' # , 'txt' => 'text-plain.png' # , 'p|pas' => 'text-x-pascal.png' # , 'patch' => 'text-x-patch.png' # , 'sql' => 'text-x-sql.png' # , 'rb' => 'application-x-ruby.png' # , 'ui' => 'text-xml.png' # , '.*\~' => 'application-x-trash' # } # , 'graphicicon' => 'image-x-generic.png' # , 'defaulticon' => 'unknown.png' # , 'diricon' => 'inode-directory.png' #- How to map files to languages , 'filetypeconf' => '%LXRroot%/templates/filetype.conf' #- Location of the Generic.pm config file , 'genericconf' => '%LXRroot%/lib/LXR/Lang/generic.conf' # "Common factor" subsection # #============================# #@LOG Configuring "common factors" # In case your LXR installation controls several trees, # put here what you consider common parameters between # your source trees. # A parameter is "common" if its value must be simultaneously # adjusted in every tree. # Pattern for extracting tree name from URL, since all # trees are usually served from the same physical server. , 'treeextract' => '([^/]*)/[^/]*$' #@IF !%_dbuser% # User name and password for DB access can be the same, # even if the database name is tree-specific. # , 'dbuser' => 'lxr' # , 'dbpass' => 'lxrpw' #@ELSE , 'dbuser' => '%DB_user%' , 'dbpass' => '%DB_password%' #@ENDIF !%_dbuser% #@IF !%_dbprefix% # Table prefix is also a common parameter # unless you stuff all tree data in a single database. # It has a default hard-coded value: # , 'dbprefix' => 'lxr_' #@ELSE , 'dbprefix' => '%DB_global_prefix%' #@ENDIF !%_dbprefix% } Index: lxr.conf =================================================================== RCS file: /cvsroot/lxr/lxr/templates/lxr.conf,v retrieving revision 1.55 retrieving revision 1.56 diff -u -d -r1.55 -r1.56 --- lxr.conf 15 Nov 2012 08:49:41 -0000 1.55 +++ lxr.conf 11 Jan 2013 12:04:27 -0000 1.56 @@ -21,177 +21,7 @@ # Global configuration section # ################################ - { - # Auxiliary tools subsection # - #============================# -#@V Configuring auxiliary tool paths - - #- Place where lxr can write temporary files - 'tmpdir' => '/tmp' - - #- Define this OR the swish-e variable depending which search engine you want to use. - #- Path to glimpse executables. - #- e.g.: , 'glimpsebin' => '/usr/local/bin/glimpse' -#@U , 'glimpsebin' => '%glimpse%' -#@U , 'glimpseindex' => '%glimpseindex%' -#@U , 'glimpsedirbase' => '%glimpsedirbase%' - #- Location of SWISH-E binary - #- e.g.: , 'swishbin' => '/usr/local/bin/swish-e' -#@U , 'swishbin' => '%swish%' -#@U , 'swishdirbase' => '%swishdirbase%' - #- Location of the SWISH-E.conf file - , 'swishconf' => '%LXRroot%/templates/swish-e.conf' - - #- Path to Exuberant Ctags executable - , 'ectagsbin' => '%ctags%' - #- Location of the ectags.conf file - , 'ectagsconf' => '%LXRroot%/templates/ectags.conf' - - #- Paths for CVS module - , 'cvspath' => '/bin:/usr/local/bin:/usr/bin:/usr/sbin' - - # Computer DNS names subsection # - #================================ -#@V Configuring host name or IP (as http://...) -#@Q --- Host name?; -2 -#@A , 'host_names' => [ '@A' -#@QR --- Alias name ? (hit return to stop); -3 -#@A , '@A' -#- , //localhost -#- , https://192.168.1.1 -#- , 'http://mycomputer.outside.domain:12345' - ] - - # HTML subsection # - #=================# -#@V Configuring HTML parameters - - # All paths in this subsection are relative to LXR root directory - - # Templates used for headers and footers - , 'htmlfatal' => 'templates/html/html-fatal.html' - , 'htmlhead' => 'templates/html/html-head.html' - , 'htmltail' => 'templates/html/html-tail.html' - , 'htmldir' => 'templates/html/html-dir-indexing.html' - # If you do not need the "last indexed" column in directory - # display (e.g. for a stable unchanging tree), erase the - # '-indexing' suffix above. - , 'htmlident' => 'templates/html/html-ident.html' - , 'htmlsearch' => 'templates/html/html-search-%search_engine%.html' - , 'htmlconfig' => 'templates/html/html-config.html' - - # htmlhead and htmltail can be customised for the various - # LXR operations. Just replace html by source (listing file), - # sourcedir (displaying directory), diff (difference markup), - # ident (identifier search), search (free-text search) - # as below (which changes nothing): -# , 'sourcehead' => 'templates/html/html-head.html' -# , 'sourcedirhead' => 'templates/html/html-head.html' - - # showconfig script is a bit special since "version" has - # no meaning for it. Better to wipe out the 'variables' selection - # links with an adequate header: - , 'showconfighead' => 'templates/html/config-head-btn-smaller.html' - - # Default character width of left version (for diff) - , 'diffleftwidth' => 50 - - # Default identifier search constraint (for ident) -# , 'identdefonly' => 1 - - # CSS style sheet - , 'stylesheet' => 'templates/lxr.css' - , 'alternate_stylesheet' => [ 'templates/classic.css' ] - - # Default character encoding - , 'encoding' => 'utf-8' - - # File management subsection # - #============================# -#@V Configuring file subsection - - # Which files should be excluded from indexing (and display). - , 'ignorefiles' => - '^\\.|~$|\\.(o|a|orig)$|^CVS$|^core$' - # Which extensions to treat as images when browsing. If a file is an image, - # it is displayed. - , 'graphicfile' => - 'bitmap|bmp|gif|icon?|jp2|jpe?g|pjpe?g|png|svg|tiff?|xbm|xpm' - - # Which file extensions are associated with which icon - # Below is an example using 'Oxygen' theme available with KDE - # small-icons/ is a symbolic link to - # /usr/share/icons/oxygen/22x22/mimetypes/ - # (This location is valid for Fedora distributions, - # check for others) -# , 'iconfolder' => 'small-icons/' - # Don't forget the final / above. -# , 'icons' => -# { 'c|pc' => 'text-x-csrc.png' -# , 'h|hh' => 'text-x-chdr.png' -# , 'c\+\+|cc|cpp|cxx' => 'text-x-c++src.png' -# , 'hpp|hxx|h\+\+' => 'text-x-c++hdr.png' -# , 'java' => 'text-x-java.png' -# , 'js' => 'application-x-javascript.png' -# , 'pl|pm|perl' => 'application-x-perl.png' -# , 'php|php3|phtml' => 'application-x-php.png' -# , 'py|python' => 'text-x-python.png' -# , 'sh|bsh|bash|ksh|zsh' => 'text-x-script.png' -# , 's?html?' => 'text-html.png' -# , 'css' => 'text-css.png' -# , 'pdf' => 'application-pdf.png' -# , 'txt' => 'text-plain.png' -# , 'p|pas' => 'text-x-pascal.png' -# , 'patch' => 'text-x-patch.png' -# , 'sql' => 'text-x-sql.png' -# , 'rb' => 'application-x-ruby.png' -# , 'ui' => 'text-xml.png' -# , '.*\~' => 'application-x-trash' -# } -# , 'graphicicon' => 'image-x-generic.png' -# , 'defaulticon' => 'unknown.png' -# , 'diricon' => 'inode-directory.png' - - #- How to map files to languages - , 'filetypeconf' => '%LXRroot%/templates/filetype.conf' - - #- Location of the Generic.pm config file - , 'genericconf' => '%LXRroot%/lib/LXR/Lang/generic.conf' - - # "Common factor" subsection # - #============================# -#@V Configuring "common factors" - - # In case your LXR installation controls several trees, - # put here what you consider common parameters between - # your source trees. - # A parameter is "common" if its value must be simultaneously - # adjusted in every tree. - - # Pattern for extracting tree name from URL, since all - # trees are usually served from the same physical server. - , 'treeextract' => '([^/]*)/[^/]*$' - -#@begin_O nodbuser - # User name and password for DB access can be the same, - # even if the database name is tree-specific. -# , 'dbuser' => 'lxr' -# , 'dbpass' => 'lxrpw' -#@end_O nodbuser -#@begin_O dbuser - , 'dbuser' => '%DB_user%' - , 'dbpass' => '%DB_password%' -#@end_O dbuser -#@begin_O nodbprefix - # Table prefix is also a common parameter - # unless you stuff all tree data in a single database. - # It has a default hard-coded value: -# , 'dbprefix' => 'lxr_' -#@end_O nodbprefix -#@begin_O dbprefix - , 'dbprefix' => '%DB_global_prefix%' -#@end_O dbprefix - } +#@ADD %LXRtmpldir%/global.conf.part # ------------------------------------------------------------------------ @@ -199,14 +29,14 @@ # Tree configuration sections # ############################### -#@V Marking tree section -#@begin_tree +#@LOG Marking tree section +#@PASS2 here_tree # ------------------------------------------------------------------------ , { # Server configuration subsection # #=================================# -#@V Configuring LXR server parameters +#@LOG Configuring LXR server parameters #- #- NOTE --------------------------------------------------- # #- ---- 'baseurl' and 'baseurl_aliases' are deprecated ---- # @@ -234,39 +64,49 @@ #- -------------------------------------------------------- # #- , -#@V The virtual root is the fixed URL part after the hostname. -#@begin_O context==s -#@Q --- Virtual root? (i.e. URL part after host); -1; ; /lxr -#@end_O context==s -#@begin_O context==m -#@Q --- Virtual root? (e.g. /lxr/something); -2 -#@end_O context==m -#- The following @D allows automatic transfer of 'virtroot' +#@MSG The virtual root is the fixed URL part after the hostname. +#- - Virtual root is slightly different on context - - +#- - because we want to handle everything with a single LXR instance - - +#@IF %_singlecontext% +#- - Single tree context - - +#@ ASK --- Virtual root? (i.e. URL part after host); -1; ; /lxr +#@ELSE +#- - Multiple trees context - - +#@ ASK --- Virtual root? (e.g. /lxr/something); -2 +#@ENDIF %_singlecontext% +#- - End of virtroot differences - - +#- +#- The following @DEFINE allows automatic transfer of 'virtroot' #- into lighttpd-lxrserver.conf. -#@D virtroot=@A -#@A 'virtroot' => '@A' +#@DEFINE virtroot="%A%" + 'virtroot' => '%A%' #- Title for this tree to display in page header area #- if you aren't satisfied with the default -#@Q --- Caption in page header? (e.g. Project XYZZY displayed by LXR); -2 -#@A , 'caption' => '@A' -#@begin_O context!=m +#@ASK --- Caption in page header? (e.g. Project XYZZY displayed by LXR); -2 + , 'caption' => '%A%' +#- +#- - In single tree context, just output a reminder in case of change; +#- - for multiple trees, generate the speed switch buttons +#@IF %_singlecontext% # Button title to switch to this tree when multiple # trees are managed by LXR # , 'shortcaption' => 'Tree' -#@end_O context!=m -#@begin_O context==m -#@begin_Y Do you want a speed switch button for this tree ?; 1; yes, no; Y, N -#@Q --- Short title for button? (e.g. XYZZY); -2 -#@A , 'shortcaption' => '@A' -#@end_Y -#@end_O context==m -#@begin_Y Do you need a specific encoding for this tree ?; 2; yes, no; Y, N +#@ELSE +#@ ASK Do you want a speed switch button for this tree ?; 1; yes, no; Y, N +#@ IF %A% eq "Y" +#@ ASK --- Short title for button? (e.g. XYZZY); -2 + , 'shortcaption' => '%A%' +#@ ENDIF +#@ENDIF %_singlecontext% +#- +#@ASK Do you need a specific encoding for this tree ?; 2; yes, no; Y, N +#@IF %A% eq "Y" -#@Q --- Encoding name? (e.g. iso-8859-1); -2 +#@ ASK --- Encoding name? (e.g. iso-8859-1); -2 # Character encoding (overrides default) -#@A , 'encoding' => '@A' -#@end_Y + , 'encoding' => '%A%' +#@ENDIF # a link of the form (prefix)($filepath)(postfix) is generated when viewing a file # example for cvsweb: @@ -278,171 +118,188 @@ # Tree location subsection # #==========================# -#@V Describing tree location +#@LOG Describing tree location # sourceroot - where to get the source files from -#@begin_C How is your tree stored?; 1; files, cvs, git, svn, bitkeeper; F,C,G,S,B -#@case_C F +#- - Handle the supported variants of tree storage - - +#- - +#@ASK,C How is your tree stored?; 1; files, cvs, git, svn, hg, bk; F,C,G,S,H,B +#@CASE %C% +#- - Case No. 1: plain files and directories +#@F: #- For ordinary directories, this specifies a directory which has each version as a #- subdirectory e.g. #- project-tree/version1/... #- project-tree/version2/... #- The names of the version directories must match the values for the Version #- variable (see the version selection subsection). -#@V A source directory contains one sub-directory for every version. -#@Q --- Source directory? (e.g. /home/myself/project-tree); -2 -#@A , 'sourceroot' => '@A' -#@case_C C - +#@ MSG A source directory contains one sub-directory for every version. +#@ ASK --- Source directory? (e.g. /home/myself/project-tree); -2 + , 'sourceroot' => '%A%' +#- +#- - Case No. 2: CVS repository +#@C: #- This specifies a CVS repository by setting the value to "cvs:" #- followed by the path to the repository. Note this must be file accessible - remote #- server access does NOT work. -#@V A CVS repository is a directory containing ,v files -#@Q --- CVS repository? (e.g. /home/myself/project-CVS); -2 -#@A , 'sourceroot' => 'cvs:@A' -#@case_C G - +#@ MSG A CVS repository is a directory containing ,v files +#@ ASK --- CVS repository? (e.g. /home/myself/project-CVS); -2 + , 'sourceroot' => 'cvs:%A%' +#- +#- - Case No. 3: GIT repository +#@G: #- For a GIT repository, the 'sourceroot' config variable points to the directory #- in which you find the `objects', `refs', `index' etc. #- directories. -#@V A Git repository is a directory containing objects, refs, index, ... subdirectories. -#@V It is usually named .git in some user directory and is thus not visible. -#@Q --- Git repository? (e.g. /home/myself/project-git/.git); -2 -#@D GITrepo=@A -#@A , 'sourceroot' => 'git:@A' +#@ MSG A Git repository is a directory containing objects, refs, index, ... subdirectories. +#@ MSG It is usually named .git in some user directory and is thus not visible. +#@ ASK --- Git repository? (e.g. /home/myself/project-git/.git); -2 +#@ DEFINE GITrepo="%A%" + , 'sourceroot' => 'git:%A%' + #- + #- Any parameters to the source access method should be specified below. + #- + #- GIT: if 'git_annotations' is non-zero, the file revision that + #- introduced each line is displayed. + #- 'git_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' => -#@Q --- display revision-ids?; 1; yes,no; 1,0 -#@A { 'git_annotations' => @A -#@Q --- display revision author name?; 1; yes,no; 1,0 -#@A , 'git_blame' => @A +#@ ASK --- display revision-ids?; 1; yes,no; 1,0 + { 'git_annotations' => %A% +#@ ASK --- display revision author name?; 1; yes,no; 1,0 + , 'git_blame' => %A% } -#@case_C S - +#- +#- - Case No. 4: Subversion repository +#@S: #- For a Subversion repository, specify svn: followed by the path to the #- repository. Presently, the implementation is limited to #- local (file-accessible) repositories. -#@V A Subversion repository is a directory containing a database for -#@V the source-tree. The present backend implementation in LXR limits -#@V access to local repositories. -#@Q --- Subversion repository? (e.g. /home/myself/project-svn); -2 -#@A , 'sourceroot' => 'svn:@A' - , 'sourceparams' => -#@Q --- display revision-ids?; 1; yes,no; 1,0 -#@A { 'svn_annotations' => @A -#@Q --- display revision author name?; 1; yes,no; 1,0 -#@A , 'svn_blame' => @A - } -#@case_C B - - #- For a BitKeeper repository, specify bk: followed by the path to the - #- repository. For BK it is also necessary to specify a 'cachepath' parameter in - #- the 'sourceparams' value below. This should point to a directory where the - #- code can write and read files. -#@V BitKeeper is proprietary software. The BK management routines are more or less -#@V in their 2005 state. This interface has not been tested for many years. -#@V There is absolutely no guarantee on BK operation. -#@Q --- BK repository? (e.g. /home/myself/project-BK); -2 -#@A , 'sourceroot' => 'cvs:@A' -#@V BK needs a read/write temporary directory. -#@Q --- BK temporary directory? (e.g. /home/myself/BKtemp); -2 - , 'sourceparams' => -#@A { 'cachepath' => '@A' } -#@end_C - -# # The string to display as the base part of every path in the tree -#- , 'sourcerootname' => 'Example' -#- # Or if you want automatic version insertion -#- , 'sourcerootname' => '$v' -#@Q Name to display for the path root? (e.g. Project or $v for version); -1; ; $v -#@A , 'sourcerootname' => '@A' +#@ MSG A Subversion repository is a directory containing a database for +#@ MSG the source-tree. The present backend implementation in LXR limits +#@ MSG access to local repositories. +#@ ASK --- Subversion repository? (e.g. /home/myself/project-svn); -2 + , 'sourceroot' => 'svn:%A%' #- #- Any parameters to the source access method should be specified below. #- - #- BK: 'cachepath' is used for temporary files - #- GIT: if 'git_annotations' is non-zero, the file revision that + #- svn: if 'svn_annotations' is non-zero, the file revision that #- introduced each line is displayed. - #- 'git_blame' will add the author of each line to the + #- 'svn_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! - #- svn: if 'svn_annotations' is non-zero, the file revision that + , 'sourceparams' => +#@ ASK --- display revision-ids?; 1; yes,no; 1,0 + { 'svn_annotations' => %A% +#@ ASK --- display revision author name?; 1; yes,no; 1,0 + , 'svn_blame' => %A% + } +#- +#- - Case No. 5: Mercurial repository +#@H: + #- For a Mercurial repository, specify hg: followed by the path to the + #- repository directory. Presently, the implementation is limited to + #- local (file-accessible) repositories. +#@ MSG A Mercurial repository is a directory containing a database for +#@ MSG the source-tree. The present backend implementation in LXR limits +#@ MSG access to local repositories. +#@ ASK --- Mercurial repository? (e.g. /home/myself/project-hg); -2 + , 'sourceroot' => 'hg:%A%' + #- + #- Any parameters to the source access method should be specified below. + #- + #- hg: if 'hg_annotations' is non-zero, the changeset that #- introduced each line is displayed. - #- 'svn_blame' will add the author of each line to the + #- 'hg_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' => +#@ ASK --- display changeset-ids?; 1; yes,no; 1,0 + { 'hg_annotations' => %A% +#@ ASK --- display changeset author name?; 1; yes,no; 1,0 + , 'hg_blame' => %A% + } +#- +#- - Case No. 6: BitKeeper repository (kept only for historical reason) +#@B: + #- For a BitKeeper repository, specify bk: followed by the path to the + #- repository. For BK it is also necessary to specify a 'cachepath' parameter in + #- the 'sourceparams' value below. This should point to a directory where the + #- code can write and read files. +#@ MSG BitKeeper is proprietary software. The BK management routines are more or less +#@ MSG in their 2005 state. This interface has not been tested for many years. +#@ MSG There is absolutely no guarantee on BK operation. +#@ ASK --- BK repository? (e.g. /home/myself/project-BK); -2 + , 'sourceroot' => 'bk:%A%' #- -#- , 'sourceparams' => -#- { 'cachepath' => '/a/path/here' -#- , 'git_annotations' => 1 -#- , 'git_blame' => 1 -#- , 'svn_annotations' => 1 -#- , 'svn_blame' => 1 -#- } + #- Any parameters to the source access method should be specified below. + #- + , 'sourceparams' => +#@ MSG BK needs a read/write temporary directory. +#@ ASK --- BK temporary directory? (e.g. /home/myself/BKtemp); -2 + { 'cachepath' => '%A%' } +#@ENDC +#- - End of tree storage - - + +# # The string to display as the base part of every path in the tree +#- , 'sourcerootname' => 'Example' +#- # Or if you want automatic version insertion +#- , 'sourcerootname' => '$v' +#@ASK Name to display for the path root? (e.g. Project or $v for version); -1; ; $v + , 'sourcerootname' => '%A%' # Version selection subsection # #==============================# -#@V Enumerating versions +#@LOG Enumerating versions , 'variables' => # Define typed variable "v". { 'v' => -#@Q Label for version selection menu? ; -1; ; Version -#@A { 'name' => '@A' +#@ASK Label for version selection menu? ; -1; ; Version + { 'name' => '%A%' # This is the list of versions to index. -#@V Versions can be explicitly enumerated, be read from a file or computed -#@V by a function. The latter case is recommended for VCS-stored trees. -#@begin_C Version enumeration method?; 1; list, file, function; L,R,F +#- +#- - Manage the different version enumeration methods - - +#@MSG Versions can be explicitly enumerated, be read from a file or computed +#@MSG by a function. The latter case is recommended for VCS-stored trees. +#@ASK,V Version enumeration method?; 1; list, file, function; L,R,F #- This can come from a file, a function or be explicitly #- ennumerated. -#@case_C R - #- From a file: - # , 'range' => [ readfile('src/versions') ] -#@Q --- Version file? (absolute path or relative to LXR root dir.); -2 -#@A , 'range' => [ readfile('@A') ] - # The default version to display - # If not specified, first in 'range' used -#@V By default, first version in list is displayed. You may also indicate -#@V a prefered version. -#@begin_C --- Default displayed version is first in 'range'?; 1; yes,no; Y,N -#@case_C N -#@Q --- Default version name?; -2 -#@A , 'default' => '@A' -#@case_C Y - # The default version to display - # If not specified, first in 'range' used -# , 'default' => 'v3.1' -#@end_C -#@case_C L - #- Explicitly: - # , 'range' => [qw(v1 v2 v3.1 v4 experimental)] +#@CASE %V% +#- +#- - Case No. 1: versions stored in a file +#@R: +#@ ASK --- Version file? (absolute path or relative to LXR root dir.); -2 + , 'range' => [ readfile('%A%') ] +#- +#- - Case No. 2: versions given explicitly in a list +#@L: , 'range' => [qw( -#@QR --- Version name? (hit return to stop); -3 -#@A @A +#@ KEEPON --- Version name? (hit return to stop); -2 + %A% +#@ ENDK )] -#@V By default, first version in list is displayed. You may also indicate -#@V a prefered version. -#@begin_C --- Default displayed version is first in 'range'?; 1; yes,no; Y,N -#@case_C N -#@Q --- Default version name?; -2 -#@A , 'default' => '@A' -#@case_C Y - # The default version to display - # If not specified, first in 'range' used -# , 'default' => 'v3.1' -#@end_C -#@case_C F +#- +#- - Case No. 3: versions dynamically computed by a function applied to each file +#@F: #- If files within a tree can have different versions, #- e.g in a CVS tree, 'range' can be specified as a #- function to call for each file: -#@V This template contains generic nearly-all-purpose functions. -#@V Since designing such a function is not a trivial exercise, -#@V you'd better choose an available one. You can later refine it -#@V to fit your needs. -#@begin_C --- Generic or custom function?; 0; files, CVS, Git, svn, custom; F,C,G,S,U -#@case_C F +#@ MSG This template contains generic nearly-all-purpose functions. +#@ MSG Since designing such a function is not a trivial exercise, +#@ MSG you'd better choose an available one. You can later refine it +#@ MSG to fit your needs. +#@ ASK,F --- Generic or custom function?; 0; files, CVS, Git, svn, hg, custom; F,C,G,S,H,U +#@ CASE %F% +#- +#- - Case No. 3a: function suited to plain files tree +#@F: #- Automatically collects the version names #- in 'sourceroot' directory which are sorted in #- lexicographic order (this may not meet the @@ -453,17 +310,16 @@ { opendir (my $dh, $LXR::Common::config->{'sourceroot'}) || die "can't open source root directory: $!"; my @dirs = grep - { /^[^.]/ + { m/^[^.]/ # Discard invisible items && -d "$LXR::Common::config->{'sourceroot'}/$_" } readdir($dh); closedir($dh); return(sort @dirs); } -#@V With a function, you MUST indicate a default version. -#@Q --- Default version name?; -1; ; head -#@A , 'default' => '@A' -#@case_C C +#- +#- - Case No. 3b: function suited to CVS tree +#@C: #- Get the releases and revisions from CVS control data. #- Revisions may not be meaningful since their numbers #- are not synchronised between files. @@ -486,10 +342,9 @@ ) #U } } -#@V With a function, you MUST indicate a default version. -#@Q --- Default version name?; -1; ; head -#@A , 'default' => '@A' -#@case_C G +#- +#- - Case No. 3c: function suited to GIT tree +#@G: #- When using a GIT repo, you can use its tags #- to create a list of versions. As an extra #- bonus, with the Linux::KernelSort Perl module, @@ -540,15 +395,14 @@ # # return @files; # } -#@V With a function, you MUST indicate a default version. -#@Q --- Default version name?; -1; ; HEAD -#@A , 'default' => '@A' -#@case_C S +#- +#- - Case No. 3d: function suited to Subversion tree +#@S: #- Get the revisions from Subversion control data. - #- Revisions may not be meaningful since their numbers - #- increment sequentially on every commit. - #- Latest revision on branches and tags may be more - #- meaningful. + #- Changeset ids may not be meaningful since their numbers + #- are not ordered chronologically. + #- Tags and branches are more related to milestones + #- for the project. #- , 'range' => sub { @@ -561,39 +415,90 @@ , $files->alltags ($LXR::Common::pathname) ) } -#@V With a function, you MUST indicate a default version. -#@Q --- Default version name?; -1; ; head -#@A , 'default' => '@A' -#@case_C U -#@V Remember to write your 'range' function. +#- +#- - Case No. 3e: function suited to Mercurial tree +#@H: + #- Get the revisions from Mercurial control data. + #- Revisions may not be meaningful since their numbers + #- increment sequentially on every commit. + #- Latest revision on branches and tags may be more + #- meaningful. + #- , 'range' => sub - { # design your own function - return 0 + { + return grep {defined} + ##### You may comment some of the following lines to limit the + ##### number of displayed revisions, provided at least one is + ##### left active. If you keep only allbranches, uncomment the + ##### 'tip' line to guarantee at least one revision is + ##### reachable. + ( $files->allbranches() + , $files->alltags () + # , 'tip' + ) } - , 'default' => 0 -#@end_C -#@end_C +#- +#- - Case No. 3f: reminder for your own function +#@U: +#@ REMIND Remember to write your 'range' function. + # CAUTION - CAUTION - CAUTION - CAUTION + # This is NOT a real function! + # You MUST write one, otherwise nothing can be displayed. + # This stubborn stub function drops anything! + # CAUTION - CAUTION - CAUTION - CAUTION + , 'range' => sub # CAUTION + { # design your own function # CAUTION + return () # CAUTION + } # CAUTION + # CAUTION - CAUTION - CAUTION - CAUTION +#@ ENDC +#@ENDC +#- - Default initial version to display (depends on enumeration method) +#- - Version list not provided by a function (file or explicit list) +#@IF %V% ne "F" +#@MSG By default, first version in list is displayed. You may also indicate +#@MSG a prefered version. +#@ ASK --- Default displayed version is first in 'range'?; 1; yes,no; Y,N +#@ IF %A% eq "N" +#@ ASK,N --- Default version name?; -2 + , 'default' => '%N%' +#@ ELSE + # The default version to display + # If not specified, first in 'range' used +# , 'default' => 'v3.1' +#@ ENDIF +#@ELSE +#- - Version list provided by a function +#@ MSG With a function, you MUST indicate a default version. +#@ CASE %F% +#@F: +#@ ASK,N --- Default version name?; -2 +#@C:S: +#@ ASK,N --- Default version name?; -1; ; head +#@G: +#@ ASK,N --- Default version name?; -1; ; HEAD +#@H: +#@ ASK,N --- Default version name?; -1; ; tip +#@U: +#@ DEFINE N='??to be provided by user??' +#@ ENDC + , 'default' => '%N%' +#@ENDIF +#- - End of version enumeration methods - - +#- } - # Define typed variable "a". First value is default. - # Meaningful for Linux kernel - # Comment out for average user source-tree - # , 'a' => - # { 'name' => 'Architecture' - # , 'range' => [qw(i386 alpha arm m68k mips ppc sparc sparc64)] - # } - # NOTE: If you implement the 'a' variable against the Kernel tree, - # don't rely on the above list of architectures. It is out-dated. - # To get an accurate list, type the following command in a - # terminal: ls path-to-kernel-source/arch/ - # The directories list in the output gives the up-to-date list. - # Alternately, use template lxrkernel.conf dedicated to kernel - # configuration. + # Other variables may be defined for use by rewrite rules + # in the subdirectory section. + # These variable definitions are needed for Linux kernel + # browsing. Read carefully the User's Manual. + # Alternately, use template lxrkernel.conf dedicated to kernel + # configuration. } # Subdirectory subsection # #=========================# -#@V Setting directory lists +#@LOG Setting directory lists # Tree-specific files to ignore (in every directory of the tree) # Extend and uncomment the following copy of the global @@ -606,28 +511,40 @@ # project history. Note that .xxx directories are hidden # by an internal hard-coded rule. Redundant example: # , 'ignoredirs' => ['CVSROOT', 'CVS', '.git'] -#@V Some directories may contain non-public project data (binaries, -#@V compilers caches, SCM control data, ...). They can be hidden from LXR. +#@MSG Some directories may contain non-public project data (binaries, +#@MSG compilers caches, SCM control data, ...). They can be hidden from LXR. +#@KEEPON --- Directory to ignore, e.g. CVSROOT or CVS? (hit return to stop) +#@ ON first , 'ignoredirs' => [qw( -#@QR --- Directory to ignore, e.g. CVSROOT or CVS? (hit return to stop); -3 -#@A @A +#@ ENDON + %A% +#@ ON last )] +#@ ENDON +#@ENDK # Where to look for include files inside the sourcetree. # This is used to hyperlink to included files. Example: -#@V If your source code uses "include" statements (#include, require, ...) -#@V LXR needs hints to resolve the destination file. -# , 'incprefix' => [ '/include', '/include/linux' ] +#@MSG If your source code uses "include" statements (#include, require, ...) +#@MSG LXR needs hints to resolve the destination file. +#@KEEPON --- Include directory, e.g. /include? (hit return to stop) +#@ ON first , 'incprefix' => [qw( -#@QR --- Include directory, e.g. /include? (hit return to stop); -3 -#@A @A +#@ ENDON + %A% +#@ ON last )] +#@ ENDON +#@ ON none +# , 'incprefix' => [ '/include', '/include/linux' ] +#@ ENDON +#@ENDK # These do funky things to paths in the system - you probably don't need them. # They are used to simulate compiler behaviour to various options # to rewrite short paths from (#)include statement and get the # real "physical" path to the file. -# , 'maps' => +# , 'maps' => # $a means substitute with current value of variable 'a' # [ '/include/asm[^\/]*/' => '/include/asm-$a/' # , '/arch/[^\/]+/' => '/arch/$a/' # ], @@ -640,109 +557,10 @@ # Data storage subsection # #=========================# -#@V Configuring data storage - - # The DBI identifier for the database to use - # For MySQL, the format is dbi:mysql:dbname=<name> - # for Postgres, it is dbi:Pg:dbname=<name>;host=localhost - # for Oracle, it is dbi:Oracle:host=localhost;sid=DEVMMS;port=1521 - # for SQLite, it is dbi:SQLite:dbname=<filename> -#@begin_O dbengine==m -#@begin_O dbpolicy==t -#@Q --- Database name?; -2 -#@D DB_name=@A -#@end_O dbpolicy==t - , 'dbname' => 'dbi:mysql:dbname=%DB_name%' -#@end_O dbengine==m -#- -#@begin_O dbengine==o - , 'dbname' => 'dbi:Oracle:host=localhost;sid=DEVMMS;port=1521' -#@end_O dbengine==o -#- -#@begin_O dbengine==p -#@begin_O dbpolicy==t -#@Q --- Database name?; -2 -#@D DB_name=@A -#@end_O dbpolicy==t - , 'dbname' => 'dbi:Pg:dbname=%DB_name%;host=localhost' -#@end_O dbengine==p -#- -#@begin_O dbengine==s -#@begin_O dbpolicy==t -#@Q --- Database file? (e.g. /home/myself/storage.db); -2 -#@D DB_name=@A -#@end_O dbpolicy==t - , 'dbname' => 'dbi:SQLite:dbname=%DB_name%' -#@end_O dbengine==s -#- -#- -#@begin_O dbengine!=s -#@begin_O nodbuser -#@Q --- DB user name?; -1; ; lxr -#@D DB_tree_user=@A -#@Q --- DB password?; -1; ; lxrpw -#@D DB_tree_password=@A - - , 'dbuser' => '%DB_tree_user%' - , 'dbpass' => '%DB_tree_password%' -#@end_O nodbuser -#- -#@begin_O dbuser -#@begin_O dbpolicy==t -#@begin_C Do you want to override the global '%DB_user%' user name?; 2; yes,no; Y,N -#@case_C Y -#@Q --- DB user name?; -1; ; lxr -#@D DB_tree_user=@A -#@Q --- DB password?; -1; ; lxrpw -#@D DB_tree_password=@A - - , 'dbuser' => '%DB_tree_user%' - , 'dbpass' => '%DB_tree_password%' -#@case_C N - # If you need to specify the username or password for the database connection, - # uncomment the following two lines -# , 'dbuser' => 'lxr' -# , 'dbpass' => 'lxrpw' -#@end_C -#@end_O dbpolicy==t -#@end_O dbuser -#@end_O dbengine!=s -#- #- -#@begin_O nodbprefix -#@Q --- DB table prefix?; -1; ; lxr_ -#@D DB_tbl_prefix=@A - - , 'dbprefix' => '%DB_tbl_prefix%' -#@end_O nodbprefix +#@ADD %LXRtmpldir%/datastorage.conf.part #- -#@begin_O dbprefix -#@begin_O dbpolicy==t - -#@begin_C Do you want to override the global '%DB_global_prefix%' table prefix?; 2; yes,no; Y,N -#@case_C Y -#@Q --- DB table prefix?; -1; ; lxr_ -#@D DB_tbl_prefix=@A - , 'dbprefix' => '%DB_tbl_prefix%' -#@case_C N - # If you need multiple lxr configurations in one database, set different table - # prefixes for them. -# , 'dbprefix' => 'lxr_' -#@end_C -#@end_O dbpolicy==t -#@end_O dbprefix - - # The following two parameters are now automatically - # generated from 'glimpsedirbase' or 'swishdirbase' and - # 'virtroot'. - # They may nevertheless be overridden here by uncommenting - # them and filling-in an appropriate absolute path. - # For using glimpse, the directory to store the .glimpse files in is required -# , 'glimpsedir' => '/path/to/glimpse/databases' - # Location of swish-e index database files if using swish-e -# , 'swishdir' => '/path/to/swish/databases' } -#@end_tree -#@here_tree +#@ENDP2 ) Index: lxrkernel.conf =================================================================== RCS file: /cvsroot/lxr/lxr/templates/lxrkernel.conf,v retrieving revision 1.6 retrieving revision 1.7 diff -u -d -r1.6 -r1.7 --- lxrkernel.conf 15 Nov 2012 08:49:41 -0000 1.6 +++ lxrkernel.conf 11 Jan 2013 12:04:27 -0000 1.7 @@ -42,13 +42,12 @@ #- ./scripts/configure-lxr.pl --conf-out=lxr.conf lxrkernel.conf #- ./scripts/configure-lxr.pl --add lxr.conf #- -#@V -#@V Welcome in the Linux kernel browsing configurator -#@V -#@V Buttons-and-menus interface is highly recommended, otherwise your -#@V screen will be seriously cluttered and ugly. -#@V This interface is selected by the 'htmlhead' parameter in the -#@V HTML subsection. +#@LOG Welcome to the Linux kernel browsing configurator +#@LOG +#@MSG Buttons-and-menus interface is highly recommended, otherwise your +#@MSG screen will be seriously cluttered and ugly. +#@MSG This interface is selected by the 'htmlhead' parameter in the +#@MSG HTML subsection. # # To use this file 'as is', move it to its final location with: # cp custom.d/lxrkernel.conf lxr.conf @@ -58,183 +57,14 @@ #- #- Have a pleasant navigation -- ajl 2012/03/29 #- updated for automatic configuration -- ajl 2012/05/05 +#- updated to use LCL statements -- ajl 2012/11/30 ( ################################ # Global configuration section # ################################ - { - # Auxiliary tools subsection # - #============================# -#@V Configuring auxiliary tool paths - - #- Place where lxr can write temporary files - 'tmpdir' => '/tmp' - - #- Define this OR the swish-e variable depending which search engine you want to use. - #- Path to glimpse executables. - #- e.g.: , 'glimpsebin' => '/usr/local/bin/glimpse' -#@U , 'glimpsebin' => '%glimpse%' -#@U , 'glimpseindex' => '%glimpseindex%' -#@U , 'glimpsedirbase' => '%glimpsedirbase%' - #- Location of SWISH-E binary - #- e.g.: , 'swishbin' => '/usr/local/bin/swish-e' -#@U , 'swishbin' => '%swish%' -#@U , 'swishdirbase' => '%swishdirbase%' - #- Location of the SWISH-E.conf file - , 'swishconf' => '%LXRroot%/templates/swish-e.conf' - - #- Path to Exuberant Ctags executable - , 'ectagsbin' => '%ctags%' - #- Location of the ectags.conf file - , 'ectagsconf' => '%LXRroot%/templates/ectags.conf' - - #- Paths for CVS module - , 'cvspath' => '/bin:/usr/local/bin:/usr/bin:/usr/sbin' - - # Computer DNS names subsection # - #================================ -#@V Configuring host name or IP (as http://...) -#@Q --- Host name?; -2 -#@A , 'host_names' => [ '@A' -#@QR --- Alias name ? (hit return to stop); -3 -#@A , '@A' -#- , //localhost -#- , https://192.168.1.1 -#- , 'http://mycomputer.outside.domain:12345' - ] - - # HTML subsection # - #=================# -#@V Configuring HTML parameters - - # All paths in this subsection are relative to LXR root directory - - # Templates used for headers and footers - , 'htmlfatal' => 'templates/html/html-fatal.html' - , 'htmlhead' => 'templates/html/html-head-btn.html' - , 'htmltail' => 'templates/html/html-tail.html' - , 'htmldir' => 'templates/html/html-dir-indexing.html' - # If you do not need the "last indexed" column in directory - # display (e.g. for a stable unchanging tree), erase the - # '-indexing' suffix above. - , 'htmlident' => 'templates/html/html-ident.html' - , 'htmlsearch' => 'templates/html/html-search-%search_engine%.html' - , 'htmlconfig' => 'templates/html/html-config.html' - - # htmlhead and htmltail can be customised for the various - # LXR operations. Just replace html by source (listing file), - # sourcedir (displaying directory), diff (difference markup), - # ident (identifier search), search (free-text search) - # as below (which changes to link interface): -# , 'sourcehead' => 'templates/html/html-head.html' -# , 'sourcedirhead' => 'templates/html/html-head.html' - - # showconfig script is a bit special since "version" has - # no meaning for it. Better to wipe out the 'variables' selection - # links with an adequate header: - , 'showconfighead' => 'templates/html/config-head-btn-smaller.html' - - # Default character width of left version (for diff) - , 'diffleftwidth' => 50 - - # Default identifier search constraint (for ident) -# , 'identdefonly' => 1 - - # CSS style sheet - , 'stylesheet' => 'templates/lxr.css' - , 'alternate_stylesheet' => [ 'templates/classic.css' ] - - # Default character encoding - , 'encoding' => 'utf-8' - - # File management subsection # - #============================# -#@V Configuring file subsection - - # Which files should be excluded from indexing (and display). - , 'ignorefiles' => - '^\\.|~$|\\.(o|a|orig)$|^CVS$|^core$' - # Which extensions to treat as images when browsing. If a file is an image, - # it is displayed. - , 'graphicfile' => - 'bitmap|bmp|gif|icon?|jp2|jpe?g|pjpe?g|png|svg|tiff?|xbm|xpm' - - # Which file extensions are associated with which icon - # Below is an example using 'Oxygen' theme available with KDE - # small-icons/ is a symbolic link to - # /usr/share/icons/oxygen/22x22/mimetypes/ - # (This location is valid for Fedora distributions, - # check for others) -# , 'iconfolder' => 'small-icons/' - # Don't forget the final / above. -# , 'icons' => -# { 'c|pc' => 'text-x-csrc.png' -# , 'h|hh' => 'text-x-chdr.png' -# , 'c\+\+|cc|cpp|cxx' => 'text-x-c++src.png' -# , 'hpp|hxx|h\+\+' => 'text-x-c++hdr.png' -# , 'java' => 'text-x-java.png' -# , 'js' => 'application-x-javascript.png' -# , 'pl|pm|perl' => 'application-x-perl.png' -# , 'php|php3|phtml' => 'application-x-php.png' -# , 'py|python' => 'text-x-python.png' -# , 'sh|bsh|bash|ksh|zsh' => 'text-x-script.png' -# , 's?html?' => 'text-html.png' -# , 'css' => 'text-css.png' -# , 'pdf' => 'application-pdf.png' -# , 'txt' => 'text-plain.png' -# , 'p|pas' => 'text-x-pascal.png' -# , 'patch' => 'text-x-patch.png' -# , 'sql' => 'text-x-sql.png' -# , 'rb' => 'application-x-ruby.png' -# , 'ui' => 'text-xml.png' -# , '.*\~' => 'application-x-trash' -# } -# , 'graphicicon' => 'image-x-generic.png' -# , 'defaulticon' => 'unknown.png' -# , 'diricon' => 'inode-directory.png' - - #- How to map files to languages - , 'filetypeconf' => '%LXRroot%/templates/filetype.conf' - - #- Location of the Generic.pm config file - , 'genericconf' => '%LXRroot%/lib/LXR/Lang/generic.conf' - - # "Common factor" subsection # - #============================# -#@V Configuring "common factors" - - # In case your LXR installation controls several trees, - # put here what you consider common parameters between - # your source trees. - # A parameter is "common" if its value must be simultaneously - # adjusted in every tree. - - # Pattern for extracting tree name from URL, since all - # trees are usually served from the same physical server. - , 'treeextract' => '([^/]*)/[^/]*$' - -#@begin_O nodbuser - # User name and password for DB access can be the same, - # even if the database name is tree-specific. -# , 'dbuser' => 'lxr' -# , 'dbpass' => 'lxrpw' -#@end_O nodbuser -#@begin_O dbuser - , 'dbuser' => '%DB_user%' - , 'dbpass' => '%DB_password%' -#@end_O dbuser -#@begin_O nodbprefix - # Table prefix is also a common parameter - # unless you stuff all tree data in a single database. - # It has a default hard-coded value: -# , 'dbprefix' => 'lxr_' -#@end_O nodbprefix -#@begin_O dbprefix - , 'dbprefix' => '%DB_global_prefix%' -#@end_O dbprefix - } +#@ADD %LXRtmpldir%/global.conf.part # ------------------------------------------------------------------------ @@ -242,48 +72,61 @@ # Tree configuration sections # ############################### -#@V Marking tree section -#@begin_tree +#@LOG Marking tree section +#@PASS2 here_tree # ------------------------------------------------------------------------ , { + # This kernel LXR configuration is generated from + # a template contributed by André Littoz (C) 2012 + # Server configuration subsection # #=================================# -#@V Configuring LXR server parameters +#@LOG Configuring LXR server parameters -#@V The virtual root is the fixed URL part after the hostname. -#@begin_O context==s -#@Q --- Virtual root? (i.e. URL part after host); -1; ; /lxr -#@end_O context==s -#@begin_O context==m -#@Q --- Virtual root? (i.e. URL part after host); -1; ; /lxr/kernel -#@end_O context==m -#- The following @D allows automatic transfer of 'virtroot' +#@MSG The virtual root is the fixed URL part after the hostname. +#- - Virtual root is slightly different on context - - +#- - because we want to handle everything with a single LXR instance - - +#@IF %_singlecontext% +#- - Single tree context - - +#@ ASK --- Virtual root? (i.e. URL part after host); -1; ; /lxr +#@ELSE +#- - Multiple trees context - - +#@ ASK --- Virtual root? (e.g. /lxr/something); -1; /lxr/kernel +#@ENDIF %_singlecontext% +#- - End of virtroot differences - - +#- +#- The following @DEFINE allows automatic transfer of 'virtroot' #- into lighttpd-lxrserver.conf. -#@D virtroot=@A -#@A 'virtroot' => '@A' +#@DEFINE virtroot="%A%" + 'virtroot' => '%A%' #- Title for this tree to display in page header area #- if you aren't satisfied with the default -#@Q --- Caption in page header?; -1; ; Linux kernel cross-references -#@A , 'caption' => '@A' -#@begin_O context!=m +#@ASK --- Caption in page header?; -1; ; Linux kernel cross-references + , 'caption' => '%A%' +#- +#- - In single tree context, just output a reminder in case of change; +#- - for multiple trees, generate the speed switch buttons +#@IF %_singlecontext% # Button title to switch to this tree when multiple # trees are managed by LXR -# , 'shortcaption' => 'Linux' -#@end_O context!=m -#@begin_O context==m -#@begin_Y Do you want a speed switch button for this tree ?; 1; yes, no; Y, N -#@Q --- Short title for button?; -1; ; Linux -#@A , 'shortcaption' => '@A' -#@end_Y -#@end_O context==m -#@begin_Y Do you need a specific encoding for this tree ?; 2; yes, no; Y, N +# , 'shortcaption' => 'Tree' +#@ELSE +#@ ASK Do you want a speed switch button for this tree ?; 1; yes, no; Y, N +#@ IF %A% eq "Y" +#@ ASK --- Short title for button? (e.g. XYZZY); -2 + , 'shortcaption' => '%A%' +#@ ENDIF +#@ENDIF %_singlecontext% +#- +#@ASK Do you need a specific encoding for this tree ?; 2; yes, no; Y, N +#@IF %A% eq "Y" -#@Q --- Encoding name? (e.g. iso-8859-1); -2 +#@ ASK --- Encoding name? (e.g. iso-8859-1); -2 # Character encoding (overrides default) -#@A , 'encoding' => '@A' -#@end_Y + , 'encoding' => '%A%' +#@ENDIF # a link of the form (prefix)($filepath)(postfix) is generated when viewing a file # example for cvsweb: @@ -295,11 +138,12 @@ # Tree location subsection # #==========================# -#@V Describing tree location +#@LOG Describing tree location # sourceroot - where to get the source files from -#@begin_C Is your tree stored in a VCS repository (cvs, git, svn, bitkeeper)?; 2; yes, no; Y, N -#@case_C N +#@ASK,C Is your tree stored in a VCS repository (cvs, git, svn, bitkeeper)?; 2; yes, no; Y, N +#@CASE %C% +#@N: #- For ordinary directories, this specifies a directory which has each version as a #- subdirectory e.g. @@ -307,27 +151,29 @@ #- project-tree/version2/... #- The names of the version directories must match the values for the Version #- variable (see the version selection subsection). -#@V A source directory contains one sub-directory for every version. -#@Q --- Source directory? (e.g. /home/myself/kernel-tree); -2 -#@A , 'sourceroot' => '@A' -#@case_C Y -#@Q Sorry, invalid configuration! You are allowed to continue but; 1; next; y -#@Q stop when asked for a new tree. Then, remove the last tree sections; 1; next; y -#@Q from the output files (*.conf and initdb.sh) and start again ; 1; next; y -#@Q either with standard configuration driver lxr.conf for VCSes ; 1; next; y -#@Q or with lxrkernel.conf after having extracted kernel source ; 1; next; y -#@Q to ordinary files and directories. ; 1; next; y -#@Q NOTE: be careful to keep the #@here_tree label and the last ; 1; next; y -#@Q right parenthesis. ; 1; OK I understand; y -#@end_C +#@ MSG A source directory contains one sub-directory for every version. +#@ ASK --- Source directory? (e.g. /home/myself/project-tree); -2 + , 'sourceroot' => '%A%' +#- +#@Y: +#@ERROR Sorry, invalid configuration! You are allowed to continue but +#@ERROR stop when asked for a new tree. Then, remove the last tree sections +#@ERROR from the output files (*.conf and initdb.sh) and start again +#@ERROR either with standard configuration driver lxr.conf for VCSes +#@ERROR or with lxrkernel.conf after having extracted kernel source +#@ERROR to ordinary files and directories. +#@ERROR NOTE: be careful to keep the #@here_tree: label and the last +#@ERROR right parenthesis. +#@ASK --- Continue now?; 1; OK I understand; y +#@ENDC # The string to display as the base part of every path in the tree , 'sourcerootname' => '$v' # Version selection subsection # #==============================# -#@V Enumerating versions -#@V This relies on script kernel-vars-grab.sh +#@LOG Enumerating versions +#@MSG This relies on script kernel-vars-grab.sh , 'variables' => @@ -343,59 +189,70 @@ { 'v' => { 'name' => 'Version' - , 'range' => [ readfile('custom.d/version_list.txt') ] + , 'range' => [ readfile('%LXRconfdir%/version_list.txt') ] +#- - Default initial version to display +#@MSG By default, first version in list is displayed. You may also indicate +#@MSG a prefered version. +#@ ASK --- Default displayed version is first in 'range'?; 1; yes,no; Y,N +#@ IF %A% eq "N" +#@ ASK,N --- Default version name?; -2 + , 'default' => '%N%' +#@ ELSE # The default version to display + # If not specified, first in 'range' used +# , 'default' => 'v3.1' +#@ ENDIF } , 'a' => { 'name' => 'Architecture' - , 'range' => [ readfile('custom.d/arch_list.txt') ] + , 'range' => [ readfile('%LXRconfdir%/arch_list.txt') ] , 'default' => 'x86' } , 'arm_mach' => { 'name' => 'ARM machine' , 'when' => '"$a" eq "arm"' - , 'range' => [ readfile('custom.d/arm_mach_list.txt') ] + , 'range' => [ readfile('%LXRconfdir%/arm_mach_list.txt') ] } , 'arm_plat' => { 'name' => 'ARM platform' , 'when' => '"$a" eq "arm"' - , 'range' => [ readfile('custom.d/arm_plat_list.txt') ] + , 'range' => [ readfile('%LXRconfdir%/arm_plat_list.txt') ] } , 'avr32_mach' => { 'name' => 'AVR32 machine' , 'when' => '"$a" eq "avr32"' - , 'range' => [ readfile('custom.d/avr32_mach_list.txt') ] + , 'range' => [ readfile('%LXRconfdir%/avr32_mach_list.txt') ] } , 'blackfin_mach' => { 'name' => 'Blackfin machine' , 'when' => '"$a" eq "blackfin"' - , 'range' => [ readfile('custom.d/blackfin_mach_list.txt') ] + , 'range' => [ readfile('%LXRconfdir%/blackfin_mach_list.txt') ] } , 'cris_arch' => { 'name' => 'CRIS architecture' , 'when' => '"$a" eq "cris"' - , 'range' => [ readfile('custom.d/cris_arch_list.txt') ] + , 'range' => [ readfile('%LXRconfdir%/cris_arch_list.txt') ] } , 'mn10300_proc' => { 'name' => 'MN10300 processor' , 'when' => '"$a" eq "mn10300"' - , 'range' => [ readfile('custom.d/mn10300_proc_list.txt') ] + , 'range' => [ readfile('%LXRconfdir%/mn10300_proc_list.txt') ] } , 'mn10300_unit' => { 'name' => 'MN10300 unit' , 'when' => '"$a" eq "mn10300"' - , 'range' => [ readfile('custom.d/mn10300_unit_list.txt') ] + , 'range' => [ readfile('%LXRconfdir%/mn10300_unit_list.txt') ] } , 'um_sys' => { 'name' => 'UM system' , 'when' => '"$a" eq "um"' - , 'range' => [ readfile('custom.d/um_sys_list.txt') ] + , 'range' => [ readfile('%LXRconfdir%/um_sys_list.txt') ] } } # Subdirectory subsection # #=========================# -#@V Setting directory lists +#@LOG Setting directory lists # Tree-specific files to ignore (in every directory of the tree) # Extend and uncomment the following copy of the global @@ -408,12 +265,17 @@ # project history. Note that .xxx directories are hidden # by an internal hard-coded rule. Redundant example: # , 'ignoredirs' => ['CVSROOT', 'CVS', '.git'] -#@V Some directories may contain non-public project data (binaries, -#@V compilers caches, SCM control data, ...). They can be hidden from LXR. +#@MSG Some directories may contain non-public project data (binaries, +#@MSG compilers caches, SCM control data, ...). They can be hidden from LXR. +#@KEEPON --- Directory to ignore, e.g. CVSROOT or CVS? (hit return to stop) +#@ ON first , 'ignoredirs' => [qw( -#@QR --- Directory to ignore, e.g. CVSROOT or CVS? (hit return to stop); -3 -#@A @A +#@ ENDON + %A% +#@ ON last )] +#@ ENDON +#@ENDK # Where to look for include files inside the sourcetree. # This is used to hyperlink to included files. @@ -442,100 +304,10 @@ # Data storage subsection # #=========================# -#@V Configuring data storage - - # The DBI ident... [truncated message content] |