| |
| 1 |
# -*-perl-*- |
|
# Configuration file for codestriker.pl. |
|
|
| 4 |
# Database to use for storing codestriker data. Examples given are |
| 5 |
# MySQL, Oracle, SQL Server, and PostgreSQL Refer to the |
| 6 |
# documentation on how to create the Codestriker database. |
| 7 |
|
| 8 |
# Example of a MySQL database URL residing on the same machine as the webserver. |
| 9 |
$db = 'DBI:mysql:dbname=codestrikerdb'; |
| 10 |
|
| 11 |
# Example of a MySQL database on host dbhost. In this situation, you need to |
| 12 |
# ensure that the webserver host has permission to connect to the database on |
| 13 |
# dbhost. Check the MySQL documentation for further details. |
|
#$db = 'DBI:mysql:dbname=codestrikerdb;host=dbhost'; |
| 15 |
|
| 16 |
# Example of an oracle database URL. |
| 17 |
#$db = 'DBI:Oracle:host=127.0.0.1;sid=local'; |
| 18 |
|
| 19 |
# Example of an SQL Server ODBC database URL. |
| 20 |
#$db = 'DBI:ODBC:Codestriker'; |
| 21 |
|
| 22 |
# Example of a PostgreSQL database URL using the native Pg driver. |
| 23 |
#$db = 'DBI:Pg:dbname=codestrikerdb'; |
| 24 |
|
| 25 |
# Example of a SQLite database URL. Not fully supported yet. |
| 26 |
#$db = 'DBI:SQLite:dbname=/var/www/codestrikerdb'; |
| 27 |
|
| 28 |
# Database user. |
| 29 |
#$dbuser = 'system'; |
| 30 |
$dbuser = 'codestriker'; |
| 31 |
|
| 32 |
# Database password. |
| 33 |
#$dbpasswd = 'manager'; |
| 34 |
$dbpasswd = 'cspasswd'; |
| 35 |
|
| 36 |
# Email addresses of admin users for this installation. Admin users |
| 37 |
# have unrestricted access to the system. Non-admin users will not |
| 38 |
# be able to create/edit/delete projects or download the full |
| 39 |
# system metric reports. If this remains commented out, then no |
| 40 |
# authentication will be required, and users have full access to the |
| 41 |
# system. |
| 42 |
#$admin_users = [ 'david.sitsky@gmail.com' ]; |
| 43 |
#$admin_users = [ 'david.sitsky@gmail.com', 'sits@users.sourceforge.net' ]; |
| 44 |
|
| 45 |
# "From" email address to use when sending emails relating to |
| 46 |
# administratative duties, such as those sent to new users, or when |
| 47 |
# a password is reset. For some email systems, you might need to |
| 48 |
# specify this as a full email address including the hostname. |
| 49 |
#$daemon_email_address = 'codestriker'; |
| 50 |
|
| 51 |
# Location of the mailing host. This is used when sending out codestriker |
| 52 |
# comments. |
| 53 |
$mailhost = 'localhost'; |
| 54 |
#$mailhost = 'smtp.iinet.com.au'; |
| 55 |
|
| 56 |
# Set the user and password parameters if $mailhost requires SMTP |
| 57 |
# authentication. If commented out, it is assumed authentication is |
| 58 |
# not required. |
| 59 |
#$mailuser = 'smtpuser'; |
| 60 |
#$mailpasswd = 'smtppasswd'; |
| 61 |
|
| 62 |
# Indicate whether to try and compress output if the client browser |
| 63 |
# supports it. This can make a tremendous difference in bandwidth, |
| 64 |
# especially over slow links. |
| 65 |
$use_compression = 0; |
| 66 |
|
| 67 |
# Location of gzip. Gzip is used only if you don't have Compress::Zlib |
| 68 |
# installed. Note, if running with mod_perl, you _must_ have Compress:Zlib |
| 69 |
# installed. If gzip is not available, this can be set to "". |
| 70 |
$gzip = '/bin/gzip'; |
| 71 |
|
| 72 |
# Location of the cvs binary. |
| 73 |
#$cvs = 'c:/Program Files/GNU/WinCvs 1.3/CVSNT/cvs.exe'; |
| 74 |
#$cvs = 'c:/Program Files/cvsnt/cvs.exe'; |
| 75 |
$cvs = '/usr/bin/cvs'; |
| 76 |
|
| 77 |
# Location of the svn binary. |
| 78 |
#$svn = 'c:/Program Files/SVN/svn.exe'; |
| 79 |
$svn = 'c:/Program Files/svn-win32-1.4.4/bin/svn.exe'; |
| 80 |
$svn = 'c:/Program Files/CollabNet Subversion/svn.exe'; |
| 81 |
#$svn = '/usr/bin/svn'; |
| 82 |
|
| 83 |
# Location of the ssh binary. This is only required if a CVS :ext |
| 84 |
# type repository is used. |
| 85 |
#$ssh='c:/Program Files/OpenSSH/bin/ssh.exe'; |
| 86 |
$ssh = '/usr/local/bin/ssh'; |
| 87 |
|
| 88 |
# Location of the p4 (Perforce client) binary. This does not need to be set |
| 89 |
# if you are bot using any Perforce repositories. |
| 90 |
$p4 = '/usr/local/bin/p4'; |
| 91 |
|
| 92 |
# Location of the vss binary. This can be ignored for deployments which don't |
| 93 |
# use VSS (Visual Source Safe). |
| 94 |
$vss = 'C:/Program Files/Microsoft Visual Studio/VSS/win32/ss.exe'; |
| 95 |
|
| 96 |
# Location of the highlight binary, which is used for highlighting source code. |
| 97 |
# Available from http://www.andre-simon.de/. If this is not set, no syntax |
| 98 |
# highlighting will be performed. |
| 99 |
$highlighter = ''; |
| 100 |
#$highlighter = 'C:/Program Files/WinHighlight/highlight.exe'; |
| 101 |
|
| 102 |
# Temporary directory Codestriker can use. For *NIX platforms, this will |
| 103 |
# /tmp by default, for Windows 2000 c:\winnt\temp and for XP, c:\windows\temp. |
| 104 |
# For Win32 deployments, these temp directories may not be accessible to |
| 105 |
# the user running IIS or Apache, so explicitly specify an apprioriate |
| 106 |
# directory here that exists on the system. For *NIX platforms, there is |
| 107 |
# usually no need to do anything here. |
| 108 |
#$tmpdir = '/tmp/codestriker'; |
| 109 |
#$tmpdir = 'c:/temp'; |
| 110 |
|
| 111 |
# If codestriker is installed differently to that described in the README file |
| 112 |
# (for example on the sourceforge servers), it may be necessary to explicitly |
| 113 |
# specify the location of the codestriker_css as a URL. This can also be |
| 114 |
# used for specifying a different CSS file to use in the html directory. |
| 115 |
#$codestriker_css = 'codestriker.css'; |
| 116 |
#$codestriker_css = 'codestriker-alternative.css'; |
| 117 |
|
| 118 |
# Valid repositories which may be selected at the create topic screen. |
| 119 |
# The order shown here is the order presented in the option list. Most |
| 120 |
# deployments will only require a single repository to be specified. |
| 121 |
# Comment out / modify entries appropriate for your deployment. |
| 122 |
# |
| 123 |
# If this list is empty it won't be possible to view the entire contents of a |
| 124 |
# file before the proposed change and/or after. All of the places |
| 125 |
# in the application that ask for, or display repository information will |
| 126 |
# be hidden and lastly, it will be impossible to make a diff review topic |
| 127 |
# on files that already checked in. |
| 128 |
# |
| 129 |
# You also need to make sure that the user running your webserver has |
| 130 |
# permission to run the client SCM program (eg, cvs, p4, svn), and to |
| 131 |
# connect to the repository. |
| 132 |
@valid_repositories = |
| 133 |
( |
| 134 |
'svn://svn.openchange.org/openchange/trunk', |
| 135 |
# Example CVSROOT of a CVS repository on the same machine as the |
| 136 |
# codestriker server. |
| 137 |
'/home/sits/cvs', |
| 138 |
|
| 139 |
# Example of a CVS repository which contains the URL to a viewcvs |
| 140 |
# installation (CVS web is also supported), followed by the |
| 141 |
# CVSROOT of the repository. |
| 142 |
'http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi /cvsroot', |
| 143 |
|
| 144 |
# Codestriker pserver repository. |
| 145 |
':pserver:anonymous:@codestriker.cvs.sourceforge.net:/cvsroot/codestriker', |
| 146 |
|
| 147 |
# The next example is the syntax used for specifying a Subversion |
| 148 |
# repository, which is simply the subversion repository URL |
| 149 |
# prefixed # by svn: |
| 150 |
'svn:http://svn.collab.net/repos/svn/trunk', |
| 151 |
|
| 152 |
# Subversion server with authentication. The user name and |
| 153 |
# password should be added to the end and separated by |
| 154 |
# semicolons. |
| 155 |
'svn:http://svn.collab.net/repos/svn/trunk;username;password', |
| 156 |
|
| 157 |
# Subversion server that uses the Subversion protocol. |
| 158 |
'svn://my.subversion.server/repos/product/trunk', |
| 159 |
|
| 160 |
# Example CVS pserver config with username and password |
| 161 |
# specified. |
| 162 |
':pserver:sits:password@cvs.sourceforge.net:/cvsroot', |
| 163 |
|
| 164 |
# Example CVS pserver config with proxy options. |
| 165 |
':pserver;proxy=abc.com;proxyport=8080:sits:pwd@cvs.dev.net', |
| 166 |
|
| 167 |
# Example CVS pserver with empty password. |
| 168 |
':pserver:anonymous:@cvs.sourceforge.net:/cvsroot', |
| 169 |
|
| 170 |
# Example CVS server which will be connected to with SSH. This |
| 171 |
# assumes the appropriate ssh keys have been created so that the |
| 172 |
# process running the Codestriker application can connect to the |
| 173 |
# CVS server without requiring a password to be entered. |
| 174 |
':ext:sits@localhost:/home/sits/cvs', |
| 175 |
|
| 176 |
# Visual SourceSafe repository on same machine at default |
| 177 |
# location. Username "admin", password "password". |
| 178 |
'vss:admin;password', |
| 179 |
|
| 180 |
# Visual SourceSafe repository on same machine, but with specific |
| 181 |
# repository location specified. |
| 182 |
'vss:c:\\Program Files\\Microsoft Visual Studio\\VSS;admin;password', |
| 183 |
|
| 184 |
# Visual SourceSafe repository located on a network fileshare. |
| 185 |
'vss:\\\\VisualSourceSafeMachineName\\SharedRepositoryPath;admin;password', |
| 186 |
# Example Win32 CVS repository on the same machine. |
| 187 |
':local:c:\\cvsrep', |
| 188 |
|
| 189 |
# Another Win32 CVS repository on the same machine. |
| 190 |
'c:/cvsrep2', |
| 191 |
|
| 192 |
# The next example is for a Perforce repository. After the |
| 193 |
# leading :perforce identifier, the next two components are the |
| 194 |
# Perforce user and password parameters. The last two parameters |
| 195 |
# after the '@' symbol represent the host and port number of |
| 196 |
# the Perforce server. |
| 197 |
'perforce:sits:password@localhost:1666', |
| 198 |
|
| 199 |
# Same as previous example, but with no password specified. |
| 200 |
'perforce:sits@localhost:1666', |
| 201 |
|
| 202 |
# The next example is a ClearCase repository, where the path is |
| 203 |
# the location of a shared snapshot view. From this view, it |
| 204 |
# should be possible to a file of any version can be |
| 205 |
# retrieved from the vob using the "cleartool get" command. It |
| 206 |
# is important that this snapshot view is accessible with the |
| 207 |
# same path specification for all developers. This is because |
| 208 |
# a diff file created by a developer will refer to the snapshot |
| 209 |
# view, and will allow Codestriker to retrieve specific files |
| 210 |
# and versions mentioned in the review text, when necessary. |
| 211 |
# It is also important that the user account running the |
| 212 |
# webserver process has permission to access to the snapshot |
| 213 |
# view. |
| 214 |
'clearcase:c:\\stuff\\view_name\\vob_name' |
| 215 |
|
| 216 |
# The next example is a repository based off a ClearCase dynamic view. |
| 217 |
# The clearcase identifier is followed by the dyn indicator, |
| 218 |
# followed by the view name, followed by the location where the |
| 219 |
# view is loaded. |
| 220 |
# 'clearcase:dyn:viewname:/vobs' |
| 221 |
# 'clearcase:dyn:viewname:P:\\viewname' |
| 222 |
); |
| 223 |
|
| 224 |
# A mapping of repository URLs to names. In any screen where a |
| 225 |
# repository is displayed, if there is a mapping for the repository |
| 226 |
# defined here, then the symbolic name will be displayed instead of |
| 227 |
# its raw URL. This is useful when the URL contains sensitive |
| 228 |
# username/password information, or the symbolic name is more |
| 229 |
# meaningful to the end-user. If there is no mapping defined for a |
| 230 |
# specific repository, its URL will be displayed. |
| 231 |
$repository_name_map = |
| 232 |
{ |
| 233 |
'/home/sits/cvs' => 'Local CVS', |
| 234 |
':pserver:sits:password@cvs.sourceforge.net:/cvsroot' => 'SF CVS' |
| 235 |
}; |
| 236 |
|
| 237 |
# A mapping of repositories to filename viewers. Examples of such systems |
| 238 |
# would be CVSweb and ViewCVS, for local repositories. Mappings are |
|
# not required for remote CVSweb and ViewCVS repositories, as they are |
| 240 |
# viewers themselves. When viewing reviews, links from filenames will be |
| 241 |
# mapped to these URLs, to obtain revision log information for that file. |
| 242 |
# The filename will be appended to the end of the URL, before any CGI |
| 243 |
# parameters. |
| 244 |
$file_viewer = |
| 245 |
{ |
| 246 |
'/home/sits/cvs' => 'http://localhost/cgi-bin/cvsweb.cgi', |
| 247 |
'svn:file:///var/svn/project/trunk' => |
| 248 |
'http://some.whe.re/cgi-bin/viewvc.cgi/trunk/?root=Project&view=markup' |
| 249 |
}; |
| 250 |
|
| 251 |
# Exclude these file types from review topics. |
| 252 |
# You will generally want to exclude any non-human-readable files. |
| 253 |
@exclude_file_types = ('rtf', 'doc', 'gif', 'bmp', 'jpeg', 'jpg', 'mdb', |
| 254 |
'ppt', 'vsd', 'xls', 'zip', 'tgz', 'tar', 'gz', |
| 255 |
'opt', 'aps', 'ncb', 'a', 'so', 'dll', 'lib', |
| 256 |
'exe', 'png', 'pdf', 'bin', 'out', 'ld', 'fm', |
| 257 |
'indd', 'wav', 'o', 'obj', 'mpp', 'vsw', 'jfif', |
| 258 |
'tif', 'tiff', 'xbm', 'fnt', 'ttf', 'pfm', 'pfb', |
| 259 |
'eps', 'wpj', 'sxi'); |
| 260 |
|
| 261 |
# The number of problems found per line drops if the size of the |
| 262 |
# topic is too large. A common inspection pitfall is for authors to |
| 263 |
# attempt to review too much material and then miss problems. |
| 264 |
# These two options allow the Codestriker administrator to limit |
| 265 |
# the length of the topics. Topics that have more lines than |
| 266 |
# $maximum_topic_size_lines are rejected when they are created. |
| 267 |
# Topics that are larger than $suggested_topic_size_lines generate |
| 268 |
# a warning displayed in the topic page, but are accepted into the |
| 269 |
# system. Codestriker measures that length of the topic by counting |
| 270 |
# the number of lines in the topic text. |
| 271 |
# |
| 272 |
# The codestriker default of not enforcing any limits is specified by |
| 273 |
# settings either option to an empty string. If you are not sure |
| 274 |
# what a reasonable limit would be, start with a suggested_topic_size_lines |
| 275 |
# set to 350, and adjust with experience. |
| 276 |
$maximum_topic_size_lines = ''; |
| 277 |
$suggested_topic_size_lines = ''; |
| 278 |
|
| 279 |
# The default viewing mode to use in the URL when creating a topic. Can |
| 280 |
# be either ($NORMAL_MODE, $COLOURED_MODE or $COLOURED_MONO_MODE). These |
| 281 |
# values should not be changed. |
| 282 |
$NORMAL_MODE = 0; |
| 283 |
$COLOURED_MODE = 1; |
| 284 |
$COLOURED_MONO_MODE = 2; |
| 285 |
|
| 286 |
$default_topic_create_mode = $COLOURED_MODE; |
| 287 |
|
| 288 |
# When displaying a topic, if this value is -1, then all files in the |
| 289 |
# topic are displayed in the one page (default old Codestriker |
| 290 |
# behaviour). If the value is 0, then only the first file is shown, |
| 291 |
# with links to display the other files. This is useful for those |
| 292 |
# deployments that review a large amount of code. |
| 293 |
$default_file_to_view = -1; |
| 294 |
|
| 295 |
# List of valid topic states. Note these values are mapped to the database |
| 296 |
# depending on their position in the list. ie, Open -> 0, Closed -> 1, etc. |
| 297 |
# There is no problem added new states dynamically, or changing the textual |
| 298 |
# names. Note, the initial topic state must be the first element. If |
| 299 |
# the 'Obsoleted' state is removed, then it will not be possible to obsolete |
| 300 |
# topics. If the 'Deleted' state is removed, then it will not be possible |
| 301 |
# to delete topics. |
| 302 |
@topic_states = ('Open', 'Closed', 'Committed', 'Obsoleted', 'Deleted'); |
| 303 |
|
| 304 |
# Which states (in topic_states, above) represent a 'readonly' state. |
| 305 |
# If a topic is in a readonly state, then certain activities are disabled, such |
| 306 |
# as adding new comments, editing the metrics of existing comments, etc. |
| 307 |
@readonly_states = ('Closed', 'Committed', 'Obsoleted', 'Deleted'); |
| 308 |
|
| 309 |
# Indicate if topics can be listed/searched. Turning this to false can be |
| 310 |
# useful for "anonymous" installations of codestriker. |
| 311 |
$allow_searchlist = 1; |
| 312 |
|
| 313 |
# The following controls project configuration. Each Codestriker topic is |
| 314 |
# a member of a specific project. Uncomment the option you want |
| 315 |
# below. Note the textual state names below cannot be changed. |
| 316 |
|
| 317 |
# Default option, projects are enabled, but they have no state |
| 318 |
# changing operations (ie, projects are always in state 'Open'). |
| 319 |
@project_states = ('Open'); |
| 320 |
|
| 321 |
# Don't use projects at all. Effectively, an implicit "default |
| 322 |
# project" is created and associated with all topics behind the scenes. |
| 323 |
# @project_states = (); |
| 324 |
# |
| 325 |
# Allow for projects to be closed. Closing a project will |
| 326 |
# not allow new topics to be created in that project. |
| 327 |
# @project_states = ('Open', 'Closed'); |
| 328 |
# |
| 329 |
# Allow for projects to be deleted. This is potentially a dangerous |
| 330 |
# option to allow, as deleting a project will delete all of its member |
| 331 |
# topics as well. Use with caution. |
| 332 |
# @project_states = ('Open', 'Deleted'); |
| 333 |
# |
| 334 |
# Allow for projects to be closed and deleted. Use with caution. |
| 335 |
# @project_states = ('Open', 'Closed', 'Deleted'); |
| 336 |
|
| 337 |
# If true, don't display any email addresses in their true form, but |
| 338 |
# truncate them, to beat SPAM harvesters. |
| 339 |
$antispam_email = 0; |
| 340 |
|
| 341 |
|
| 342 |
# If comments_sent_to_topic_author is true, codestriker will send |
| 343 |
# out email to the topic owner and when a comment is added. If this |
| 344 |
# option is false, no email will be sent the topic owner. |
| 345 |
# |
| 346 |
# If comments_sent_to_commenter is set to true, codestriker will |
| 347 |
# blind cc (bcc) the comment author on all comments. The preceding |
| 348 |
# comments_sent_to_topic_author must be true in order for the blind |
| 349 |
# cc of emails to be enabled. |
| 350 |
# |
| 351 |
# If topic_state_change_sent_to_reviewers is set to true, codestriker |
| 352 |
# will send email to the reviewer list when a topic state is changed. |
| 353 |
# |
| 354 |
# Emails about each comment may not be needed if a meeting |
| 355 |
# is planned to discuss the topic. If the comment submitter specifies |
| 356 |
# a cc user, an email is always sent out, regardless of any email |
| 357 |
# settings. |
| 358 |
$email_send_options = |
| 359 |
{ |
| 360 |
comments_sent_to_topic_author => 1, |
| 361 |
comments_sent_to_commenter => 0, |
| 362 |
topic_state_change_sent_to_reviewers => 0 |
| 363 |
}; |
| 364 |
|
| 365 |
# Default width of tabs. Most developers expect this to be 8, but |
| 366 |
# some expect to see 4. This is also stored in the user's cookie, and |
| 367 |
# can be changed dynamically on the view topic screen. |
| 368 |
$default_tabwidth = 8; |
| 369 |
|
| 370 |
# Indicate whether the diffs presented in a topic should be ordered by |
| 371 |
# filename. For some deployments, it is important that the order of the |
| 372 |
# diffs are presented in the same order as it was in the file. Subversion |
| 373 |
# reports diffs I believe in order of modification, which makes it |
| 374 |
# quite arbitrary, so the default is to sort. |
| 375 |
$sort_diffs_by_filename = 1; |
| 376 |
|
| 377 |
# Bug database to update. Currently, Bugzilla, Flyspray and TestDirector |
| 378 |
# are supported, but it is straight-forward to support other bug |
| 379 |
# databases. To enable Bugzilla, set $bug_db to "bugzilla", and set |
| 380 |
# the following parameters to your setup. To enable Flyspray, set |
| 381 |
# $bug_db to "flyspray", and set the relevant parameters. To enable |
| 382 |
# TestDirectory, set $bug_db to "testdirector" and set the relevant |
| 383 |
# parameters. If the $bug_db is an empty string, all bug-tracking related |
| 384 |
# features will be disabled. To allow the association of a bug ID |
| 385 |
# with a topic, without any physical connection to a bug database, |
| 386 |
# set the value to "noconnection". |
| 387 |
|
| 388 |
$bug_db = ''; |
| 389 |
#$bug_db = 'bugzilla'; |
| 390 |
#$bug_db = 'flyspray'; |
| 391 |
#$bug_db = 'testdirector'; |
| 392 |
$bug_db = 'noconnection'; |
| 393 |
|
| 394 |
# Bugzilla database connection details. |
| 395 |
#$bug_db_host = 'localhost'; |
| 396 |
#$bug_db_name = 'bugs'; |
| 397 |
#$bug_db_password = 'bugs_password'; |
| 398 |
#$bug_db_dbname = 'bugs'; |
| 399 |
#$bug_db_user_id = '2'; |
| 400 |
|
| 401 |
# Flyspray database connection details |
| 402 |
#$flyspray_db_host = 'localhost'; |
| 403 |
#$flyspray_db_name = 'flyspray'; |
| 404 |
#$flyspray_db_password = 'flyspray_password'; |
| 405 |
#$flyspray_db_dbname = 'flyspray_dev'; |
| 406 |
#$flyspray_db_user_id = 50; |
| 407 |
|
| 408 |
# TestDirector connection details |
| 409 |
#$testdirector_url = 'http://emea-testdir:8080/qcbin'; |
| 410 |
#$testdirector_user_id = 'robh'; |
| 411 |
#$testdirector_password = ''; |
| 412 |
#$testdirector_domain = 'DEFAULT'; |
| 413 |
#$testdirector_project = 'BPM33'; |
| 414 |
|
| 415 |
# The URL to the bug tracking system. The bug number is appended to the |
| 416 |
# end of this string when URLs are generated. This can be left blank if |
| 417 |
# there is no need for bug-tracking integration. Below are some example |
| 418 |
# URLs for Bugzilla and Flyspray. |
| 419 |
$bugtracker = ''; |
| 420 |
$bugtracker = 'http://localhost.localdomain/bugzilla/show_bug.cgi?id='; |
| 421 |
#$bugtracker = '/flyspray_dev/?do=details&id='; |
| 422 |
|
| 423 |
# Some bug tracking systems store details of the files changed under each bug |
| 424 |
# ID. A generic plugin for bugzilla is scmbug which can be used to link |
| 425 |
# with source control systems such as subversion. The following flag |
| 426 |
# enables/disables the ability for a user to create a topic by just |
| 427 |
# using a Bug ID. |
| 428 |
#$scmbug_hostname = 'localhost'; |
| 429 |
#$scmbug_port = 3872; |
| 430 |
#$scmbug_lib_dir = 'C:/Program Files/Scmbug/share/scmbug/lib'; |
| 431 |
|
| 432 |
# LXR database. Each repository can be optionally mapped to a |
| 433 |
# different LXR deployment. If a repository has an associated LXR |
| 434 |
# mapping, then create a new entry where the repository string is the |
| 435 |
# key, and the value is another map, where "db" is the LXR database |
| 436 |
# URL, "user" is the database user, "password" is the data password, |
| 437 |
# and "url" is the base LXR URL for viewing where an identifier is |
| 438 |
# defined/used. |
| 439 |
$lxr_map = |
| 440 |
{ |
| 441 |
# '/home/sits/cvs' => { db => 'DBI:Pg:dbname=lxr', |
| 442 |
# user => 'lxr', |
| 443 |
# password => '', |
| 444 |
# url => 'http://localhost.localdomain/lxr/ident?i=' |
| 445 |
# }, |
| 446 |
# |
| 447 |
# 'svn:http://svn.collab.net/repos/svn/trunk' => |
| 448 |
# { db => 'DBI:Pg:dbname=lxr2', |
| 449 |
# user => 'lxr', |
| 450 |
# password => '', |
| 451 |
# url => 'http://localhost.localdomain/lxr2/ident?i=' |
| 452 |
# } |
| 453 |
}; |
| 454 |
|
| 455 |
# Character encoding to use when reading topic text. Default is utf8 |
| 456 |
# (compatible with ASCII) if not set, but this can be over-ridden here. |
| 457 |
# List of example encoding names can be retrieved from the following |
| 458 |
# URL: http://perldoc.perl.org/Encode/Supported.html. |
| 459 |
$topic_text_encoding = 'utf8'; |
| 460 |
#$topic_text_encoding = 'gb2312'; |
| 461 |
|
| 462 |
# Each comment thread (or issue) that is created against a specific |
| 463 |
# code line in Codestriker can have a configurable number of |
| 464 |
# user-defined metrics recorded against it. |
| 465 |
# |
| 466 |
# Every site has their own requirements, below are a number of example |
| 467 |
# configurations. The "name" attribute refers to the name of the |
| 468 |
# metric being recorded. The "values" attribute is a list of values |
| 469 |
# that this metric can be assigned to. The "default_value" attribute |
| 470 |
# is optional, and indicates what the default value of the metric is |
| 471 |
# assigned to. If this attribute is not specified, then the user will |
| 472 |
# be required to specify a value for a metric when creating a new |
| 473 |
# comment thread. This is recommended, so that users think about what |
| 474 |
# these values should be, rather than blindly accepting default |
| 475 |
# values. For the "Status" metric below however, it is recording the |
| 476 |
# "state" of the thread, so an initial state of "Submitted" is reasonable. |
| 477 |
# For the other metrics below, an initial value makes no sense. |
| 478 |
# Metric items can have an optional show_on_main_page list that will |
| 479 |
# force the numbers of comments with the metric settings to be reported |
| 480 |
# on the main page of codestriker. |
| 481 |
$comment_state_metrics = |
| 482 |
[ |
| 483 |
{ name => 'Status', |
| 484 |
values => ['Submitted', 'Invalid', 'Completed'], |
| 485 |
default_value => 'Submitted', |
| 486 |
show_on_mainpage => ['Submitted' ] |
| 487 |
} |
| 488 |
]; |
| 489 |
|
| 490 |
# Two metrics defined: Status and Type. |
| 491 |
#$comment_state_metrics = |
| 492 |
# [ |
| 493 |
# { name=>'Status', values=>['Submitted', 'Invalid', 'Completed'], |
| 494 |
# default_value=>'Submitted' }, |
| 495 |
# { name=>'Type', values=>['Style', 'Minor', 'Major', 'Severe'] } |
| 496 |
# ]; |
| 497 |
|
| 498 |
# Four metrics defined: Status, Level, Mode and Type. |
| 499 |
#$comment_state_metrics = |
| 500 |
# [ |
| 501 |
# { name=>'Status', values=>['Submitted', 'Invalid', 'Completed'], |
| 502 |
# default_value=>'Submitted' }, |
| 503 |
# { name=>'Level', values=>['Major', 'Minor'] }, |
| 504 |
# { name=>'Mode', values=>['Missing', 'Wrong', 'Unclear', 'Suggestion'] }, |
| 505 |
# { name=>'Type', values=>['Logic', 'Data Handling', 'Interface', |
| 506 |
# 'Error Handling', 'Performance', 'Comments', |
| 507 |
# 'Standards'] } |
| 508 |
# ]; |
| 509 |
# |
| 510 |
# Case where no comment thread metrics are to be used. |
| 511 |
#$comment_state_metrics = []; |
| 512 |
|
| 513 |
|
| 514 |
# Allows you to override the default title of "Codestriker %version%". |
| 515 |
# $title = "Codestriker $Codestriker::VERSION"; |
| 516 |
|
| 517 |
# This options configures the metric support in codestriker. You have |
| 518 |
# the following options: |
| 519 |
# |
| 520 |
# $metric_config = "none", "basic", "all", "metric name, metric name, etc" |
| 521 |
# |
| 522 |
# "none" - turns off all extra metric support in the application. The |
| 523 |
# metric page will only display and manage data that is strictly |
| 524 |
# required to perform the review. Codestriker will not require any |
| 525 |
# addition data input from the reviewers and authors. This is the |
| 526 |
# default. However, you still get basic data like how many topics are |
| 527 |
# being created and how problems are being found. |
| 528 |
# |
| 529 |
# "basic" - Turns on the metrics that are considered to be essential |
| 530 |
# for a metric program. It will require that reviewers and authors |
| 531 |
# enter the time spent reviewing the topic, the time spent in the |
| 532 |
# review meeting, and the time spent preparing for the review. The |
| 533 |
# metric selection assumes that you are following a formal review |
| 534 |
# process with a preparation meeting, and a defect review meeting. |
| 535 |
# |
| 536 |
# kickoff time - time spent preparing for the review |
| 537 |
# checking time - time spent actually reviewing the topic. |
| 538 |
# logging meeting duration - the time spent in the logging meeting. |
| 539 |
# |
| 540 |
# "all" - Turns on all of the metrics that one could possibly want to |
| 541 |
# track. The list of metrics is from the book "Software Inspection" by |
| 542 |
# Gilb and Graham. You should probably not use this unless you are |
| 543 |
# using a formal process that is well established. You may want to |
| 544 |
# enable this temporally to get a idea of the types of metrics that |
| 545 |
# are supported. |
| 546 |
# |
| 547 |
# "name,name" - Lastly, you can pick and chose what metrics you would |
| 548 |
# like to enable. just list the metric names in a comma separated |
| 549 |
# list. You can see all of the build in metrics in the |
| 550 |
# lib/Codestriker.pm file. For example, if you don't hold a kick off |
| 551 |
# meeting, and but do hold a logging meeting, the basic option will not |
| 552 |
# quit fit. You should set the $metric_config as: |
| 553 |
# $metric_config = "checking time,logging meeting duration". |
| 554 |
# |
| 555 |
# If you don't like our choices of metrics, the names, descriptions, |
| 556 |
# etc feel free to edit the lib/Codestriker.pm. It contains |
| 557 |
# documentations on how to add your own metrics into codestriker. It |
| 558 |
# is easy to do, and does not require any coding. |
| 559 |
|
|
$metric_config = "all"; |
|
|
|
|
| |