Thread: [Codestriker-commits] CVS update: codestriker/doc codestriker.sgml
Brought to you by:
sits
From: <si...@us...> - 2004-11-22 11:12:45
|
Created Codestriker topic at: http://codestriker.sourceforge.net/cgi-bin/codestriker.pl?topic=1297110&action=view&brmode=1&fview=-1 User: sits Date: 04/11/22 03:12:28 Modified: doc codestriker.sgml Log: Updated ClearCase URL Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.42 retrieving revision 1.43 diff -u -r1.42 -r1.43 --- codestriker.sgml 21 Nov 2004 05:00:07 -0000 1.42 +++ codestriker.sgml 22 Nov 2004 11:12:27 -0000 1.43 @@ -44,7 +44,7 @@ <ulink url="http://subversion.tigris.org">Subversion</ulink>, <ulink url="http://www.perforce.com">Perforce</ulink>, <ulink - url="http://www.rational.com/products/clearcase">ClearCase</ulink> + url="http://www.ibm.com/software/awdtools/clearcase">ClearCase</ulink> and <ulink url="http://msdn.microsoft.com/ssafe">Visual SourceSafe</ulink>. |
From: <si...@us...> - 2004-11-24 20:40:24
|
Created Codestriker topic at: http://codestriker.sourceforge.net/cgi-bin/codestriker.pl?topic=2393555&action=view&brmode=1&fview=-1 User: sits Date: 04/11/24 12:40:04 Modified: doc codestriker.sgml Log: Updated IIS+Perl link Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.44 retrieving revision 1.45 diff -u -r1.44 -r1.45 --- codestriker.sgml 24 Nov 2004 11:18:07 -0000 1.44 +++ codestriker.sgml 24 Nov 2004 20:40:00 -0000 1.45 @@ -1294,7 +1294,7 @@ <para> Further information on setting up IIS with Perl CGI can be found from <ulink - url="http://www.mhuffman.com/notes/cgi/cgi_config.html">http://www.mhuffman.com/notes/cgi/cgi_config.html</ulink>. + url="http://support.microsoft.com/kb/q245225">http://support.microsoft.com/kb/q245225</ulink>. </para> </sect1> |
From: <si...@us...> - 2005-06-09 23:33:36
|
Created Codestriker topic at: http://codestriker.sourceforge.net/cgi-bin/codestriker.pl?topic=8593379&action=view User: sits Date: 05/06/09 16:33:16 Modified: doc codestriker.sgml Log: Updated minor change in doco Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.48 retrieving revision 1.49 diff -u -r1.48 -r1.49 --- codestriker.sgml 22 May 2005 22:26:02 -0000 1.48 +++ codestriker.sgml 9 Jun 2005 23:33:15 -0000 1.49 @@ -1144,7 +1144,7 @@ For PPM2: <programlisting> C:\> ppm -PPM> set location http://theoryx5.uwinnipeg.ca/ppmpackages +PPM> set repository oi http://theoryx5.uwinnipeg.ca/ppmpackages PPM> set save PPM> install mod_perl </programlisting> |
From: <si...@us...> - 2006-05-31 07:05:22
|
User: sits Date: 06/05/31 00:02:19 Modified: doc codestriker.sgml Log: Added doco for creating utf8 databases for MySQL and PostgreSQL. SQL Server works as is. Oracle is still an unknown. Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.52 retrieving revision 1.53 diff -u -r1.52 -r1.53 --- codestriker.sgml 18 Apr 2006 10:45:40 -0000 1.52 +++ codestriker.sgml 31 May 2006 07:02:19 -0000 1.53 @@ -161,6 +161,8 @@ available for download from <ulink url="http://www.mysql.com">http://www.mysql.com</ulink>. + Make sure you use at least version 4.1 or above, as this + supports UTF8 databases. For Linux RedHat distributions, the necessary packages required are mysql, mysql-devel, mysql-server, which may or may not already be present on your system. Depending on @@ -187,7 +189,7 @@ substitute a suitable database password instead of cspasswd as shown here. <programlisting> -CREATE DATABASE codestrikerdb; +CREATE DATABASE codestrikerdb CHARACTER SET utf8; GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP,REFERENCES ON codestrikerdb.* TO codestriker@localhost IDENTIFIED BY 'cspasswd'; @@ -238,7 +240,7 @@ following commands: <programlisting> % createuser --username=postgres -d -A codestriker -% createdb --username=codestriker codestrikerdb +% createdb -E UTF8 --username=codestriker codestrikerdb </programlisting> </para> <para> |
From: <si...@us...> - 2006-06-11 06:34:33
|
User: sits Date: 06/06/10 23:34:30 Modified: . codestriker.conf doc codestriker.sgml Log: More updates to the documentation Index: codestriker.conf =================================================================== RCS file: /cvsroot/codestriker/codestriker/codestriker.conf,v retrieving revision 1.82 retrieving revision 1.83 diff -u -r1.82 -r1.83 --- codestriker.conf 10 Jun 2006 02:58:32 -0000 1.82 +++ codestriker.conf 11 Jun 2006 06:34:29 -0000 1.83 @@ -5,10 +5,12 @@ # MySQL, Oracle, SQL Server, and PostgreSQL Refer to the # documentation on how to create the Codestriker database. -# Example of a MySQL database URL. +# Example of a MySQL database URL residing on the same machine as the webserver. $db = 'DBI:mysql:dbname=codestrikerdb'; -# Example of a MySQL database on host dbhost. +# Example of a MySQL database on host dbhost. In this situation, you need to +# ensure that the webserver host has permission to connect to the database on +# dbhost. Check the MySQL documentation for further details. #$db = 'DBI:mysql:dbname=codestrikerdb;host=dbhost'; # Example of an oracle database URL. @@ -95,6 +97,10 @@ # in the application that ask for, or display repository information will # be hidden and lastly, it will be impossible to make a diff review topic # on files that already checked in. +# +# You also need to make sure that the user running your webserver has +# permission to run the client SCM program (eg, cvs, p4, svn), and to +# connect to the repository. @valid_repositories = ( # Example CVSROOT of a CVS repository on the same machine as the Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.55 retrieving revision 1.56 diff -u -r1.55 -r1.56 --- codestriker.sgml 10 Jun 2006 07:45:30 -0000 1.55 +++ codestriker.sgml 11 Jun 2006 06:34:30 -0000 1.56 @@ -137,9 +137,6 @@ <para>unpacking and configuring Codestriker.</para> </listitem> </itemizedlist> - Note for Win32 systems, only use Perl 5.6.X and Apache 1.X. - Perl 5.8.X and Apache 2.X have issues on Win32 which prevent - Codestriker working correctly. </para> <sect1 id="codestriker-database-creation"> @@ -163,6 +160,10 @@ url="http://www.mysql.com">http://www.mysql.com</ulink>. Make sure you use at least version 4.1 or above, as this supports UTF8 databases. + <emphasis>Note under Solaris, it seems at + the time of writing that only the 32-bit version of Perl and + MySQL (and DBD::mysql) can be used, the 64-bit versions + don't work.</emphasis> For Linux RedHat distributions, the necessary packages required are mysql, mysql-devel, mysql-server, which may or may not already be present on your system. Depending on @@ -242,6 +243,11 @@ % createuser --username=postgres -d -A codestriker % createdb -E UTF8 --username=codestriker codestrikerdb </programlisting> + If the last command claims UTF8 is an unknown encoding, try + the value UNICODE. If that still fails, you have a + distribution which wasn't configured with + --enable-multibyte. Try downloading the latest version of + PostgreSQL. </para> <para> Make sure your <filename>pg_hba.conf</filename> file is @@ -365,9 +371,12 @@ <programlisting> $db = 'DBI:mysql:dbname=codestrikerdb;host=dbhost'; </programlisting> - The database user and password also need to be specified. If - your username was "codestriker", and the password was - "cspasswd", the settings would be just: + In this situation, you need to ensure that the webserver host + has permission to connect to the database on dbhost. Check + the MySQL documentation for further details. The database + user and password also need to be specified. If your username + was "codestriker", and the password was "cspasswd", the + settings would be just: <programlisting> # Database user. $dbuser = 'codestriker'; @@ -456,6 +465,10 @@ # in the application that ask for, or display repository information will # be hidden and lastly, it will be impossible to make a diff review topic # on files that already checked in. +# +# You also need to make sure that the user running your webserver has +# permission to run the client SCM program (eg, cvs, p4, svn), and to +# connect to the repository. @valid_repositories = ( # Example CVSROOT of a CVS repository on the same machine as the @@ -1037,8 +1050,6 @@ Perl is available by default for all UNIX systems. For Windows, you can download it for free from <ulink url="http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl">http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl</ulink>. - Only use Perl 5.6.X, as Perl 5.8.X for Win32 has issues that - prevent Codestriker from working correctly. </para> <para> To run <filename>install.pl</filename> under UNIX, do the @@ -1175,20 +1186,16 @@ Apache. For installing <command>mod_perl</command> under Windows, <ulink url="http://www.webmatrix.net/log/modperl-win32">http://www.webmatrix.net/log/modperl-win32</ulink> - contains installation information. For PPM3 users, you + contains installation information. You should be able to install it by typing: <programlisting> C:\> ppm PPM> rep add theory http://theoryx5.uwinnipeg.ca/ppmpackages PPM> install mod_perl </programlisting> - For PPM2: -<programlisting> -C:\> ppm -PPM> set repository oi http://theoryx5.uwinnipeg.ca/ppmpackages -PPM> set save -PPM> install mod_perl -</programlisting> + Note mod_perl has known to be a little flacky under Windows. + Make sure you get Codestriker working deployed as a CGI + script before trying to use mod_perl. </para> <para> The following shows the configuration settings for an Apache @@ -2926,25 +2933,18 @@ (including relevant contents of your apache error log file), and I'll be happy to help you out. </para> - <para> - If you see an error message like: - <programlisting> -[Tue Jan 6 08:41:49 2004] [error] Bizarre copy of HASH in assign at -/usr/lib/perl5/5.6.0/Carp/Heavy.pm line 79 - </programlisting> - This is apparently due to a bug in Perl 5.6.0. If you upgrade - to Perl 5.6.1, the problem should go away. - </para> </chapter> <chapter> <title>Future Plans</title> <para> <itemizedlist> + <listitem><para>Respository-specific topic-creation fields</para></listitem> + <listitem><para>REST-style URLs</para></listitem> + <listitem><para>User authentication</para></listitem> <listitem><para>Web-based configuration</para></listitem> <listitem><para>Per-user preferences for email</para></listitem> <listitem><para>Ability to review formatted design documents</para></listitem> - <listitem><para>User authentication</para></listitem> </itemizedlist> </para> </chapter> |
From: <si...@us...> - 2006-06-12 23:04:40
|
User: sits Date: 06/06/12 16:04:36 Modified: doc codestriker.sgml Log: Fixed spelling mistake Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.56 retrieving revision 1.57 diff -u -r1.56 -r1.57 --- codestriker.sgml 11 Jun 2006 06:34:30 -0000 1.56 +++ codestriker.sgml 12 Jun 2006 23:04:36 -0000 1.57 @@ -1193,7 +1193,7 @@ PPM> rep add theory http://theoryx5.uwinnipeg.ca/ppmpackages PPM> install mod_perl </programlisting> - Note mod_perl has known to be a little flacky under Windows. + Note mod_perl has known to be a little flaky under Windows. Make sure you get Codestriker working deployed as a CGI script before trying to use mod_perl. </para> |
From: <si...@us...> - 2006-07-04 00:33:42
|
User: sits Date: 06/07/03 17:33:32 Modified: . CHANGELOG codestriker.conf doc codestriker.sgml Log: Adding extra documentation for linking to a ClearCase dynamic view repository. Index: CHANGELOG =================================================================== RCS file: /cvsroot/codestriker/codestriker/CHANGELOG,v retrieving revision 1.192 retrieving revision 1.193 diff -u -r1.192 -r1.193 --- CHANGELOG 13 Jun 2006 23:38:40 -0000 1.192 +++ CHANGELOG 4 Jul 2006 00:33:31 -0000 1.193 @@ -17,6 +17,10 @@ URL. See the codestriker.conf file for more information. Submitted by Edwin Fine <edw...@ve...>. +* New repository module for linking to ClearCase dynamic views. See + the configuration file and/or manual for example configurations. + Submitted by Avinandan Sengupta <avi...@gm...>. + * Modified the way Perforce retrieves files from the depot, as servers set with a security level of 2 or above were not receiving password information. This has been addressed by modifying the command line Index: codestriker.conf =================================================================== RCS file: /cvsroot/codestriker/codestriker/codestriker.conf,v retrieving revision 1.85 retrieving revision 1.86 diff -u -r1.85 -r1.86 --- codestriker.conf 21 Jun 2006 06:00:47 -0000 1.85 +++ codestriker.conf 4 Jul 2006 00:33:31 -0000 1.86 @@ -179,6 +179,9 @@ 'clearcase:c:\\stuff\\view_name\\vob_name' # The next example is a repository based off a ClearCase dynamic view. + # The clearcase identifier is followed by the dyn indicator, + # followed by the view name, followed by the location where the + # view is loaded. # 'clearcase:dyn:c:\\stuff\\dynamic_view_name\\vob_name' ); Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.59 retrieving revision 1.60 diff -u -r1.59 -r1.60 --- codestriker.sgml 21 Jun 2006 06:00:50 -0000 1.59 +++ codestriker.sgml 4 Jul 2006 00:33:31 -0000 1.60 @@ -546,6 +546,9 @@ 'clearcase:c:\\stuff\\view_name\\vob_name', # The next example is a repository based off a ClearCase dynamic view. + # The clearcase identifier is followed by the dyn indicator, + # followed by the view name, followed by the location where the + # view is loaded. 'clearcase:dyn:c:\\stuff\\dynamic_view_name\\vob_name' ); </programlisting> |
From: <si...@us...> - 2006-07-04 00:36:10
|
User: sits Date: 06/07/03 17:36:01 Modified: . codestriker.conf doc codestriker.sgml Log: Slight change to ClearCase example Index: codestriker.conf =================================================================== RCS file: /cvsroot/codestriker/codestriker/codestriker.conf,v retrieving revision 1.86 retrieving revision 1.87 diff -u -r1.86 -r1.87 --- codestriker.conf 4 Jul 2006 00:33:31 -0000 1.86 +++ codestriker.conf 4 Jul 2006 00:36:01 -0000 1.87 @@ -182,7 +182,7 @@ # The clearcase identifier is followed by the dyn indicator, # followed by the view name, followed by the location where the # view is loaded. - # 'clearcase:dyn:c:\\stuff\\dynamic_view_name\\vob_name' + # 'clearcase:dyn:viewname:/vobs' ); # A mapping of repository URLs to names. In any screen where a Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.60 retrieving revision 1.61 diff -u -r1.60 -r1.61 --- codestriker.sgml 4 Jul 2006 00:33:31 -0000 1.60 +++ codestriker.sgml 4 Jul 2006 00:36:01 -0000 1.61 @@ -549,7 +549,7 @@ # The clearcase identifier is followed by the dyn indicator, # followed by the view name, followed by the location where the # view is loaded. - 'clearcase:dyn:c:\\stuff\\dynamic_view_name\\vob_name' + # 'clearcase:dyn:viewname:/vobs' ); </programlisting> </para> |
From: <si...@us...> - 2006-08-09 03:50:51
|
User: sits Date: 06/08/08 20:50:49 Modified: doc codestriker.sgml Log: Added documentation for Win32 deployment specific information. Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.61 retrieving revision 1.62 diff -u -r1.61 -r1.62 --- codestriker.sgml 4 Jul 2006 00:36:01 -0000 1.61 +++ codestriker.sgml 9 Aug 2006 03:50:49 -0000 1.62 @@ -1,4 +1,4 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> +s<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <!-- Note the /usr/share/sgml/docbook/sgml-dtd-3.1/dbnotn.mod file had to be modified to accept PNG images (simple change). Should migrate to @@ -1078,7 +1078,8 @@ <para> Perl is available by default for all UNIX systems. For Windows, you can download it for free from <ulink - url="http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl">http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl</ulink>. + url="http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl">http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl</ulink>. Note if you are using IIS as your web-server, please + see <xref linkend="IIS configuration"> on appropriate ActivePerl releases. </para> <para> To run <filename>install.pl</filename> under UNIX, do the @@ -1115,8 +1116,9 @@ url="http://httpd.apache.org">http://httpd.apache.org</ulink>), which is available for download for both UNIX and Window platforms. Apache should be already available for most UNIX - distributions. Apache 1.X is recommended for Win32 systems, - as 2.X may have issues with running Codestriker. + distributions. Apache 1.X or 2.X can be used for Win32 systems + deploying Codestriker as a CGI script. For Win32 mod_perl + installations, Apache 1.X is recommended. </para> <para> <emphasis>Note any Codestriker or Apache configuration changes @@ -1318,11 +1320,15 @@ </sect2> </sect1> - <sect1> + <sect1 id="IIS configuration"> <title>IIS configuration</title> <para> This section deals with deploying Codestriker under IIS, as - a CGI script. These instructions were performed on a + a CGI script. <emphasis>At the time of writing, the current version of ActivePerl (5.8.8.817) + contains a version of CGI.pm which is broken for IIS deployments. + Use <ulink + url="http://downloads.activestate.com/ActivePerl/Windows/5.8/ActivePerl-5.8.7.813-MSWin32-x86-148120.msi">http://downloads.activestate.com/ActivePerl/Windows/5.8/ActivePerl-5.8.7.813-MSWin32-x86-148120.msi</ulink> instead.</emphasis> + These instructions were performed on a Windows 2000 machine, so hopefully this provides an indication as to what needs to be performed for other Win32 configurations. Startup the IIS configuration application by |
From: <si...@us...> - 2006-08-09 03:57:37
|
User: sits Date: 06/08/08 20:57:36 Modified: doc codestriker.sgml Log: Spurious character removed Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.62 retrieving revision 1.63 diff -u -r1.62 -r1.63 --- codestriker.sgml 9 Aug 2006 03:50:49 -0000 1.62 +++ codestriker.sgml 9 Aug 2006 03:57:35 -0000 1.63 @@ -1,4 +1,4 @@ -s<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <!-- Note the /usr/share/sgml/docbook/sgml-dtd-3.1/dbnotn.mod file had to be modified to accept PNG images (simple change). Should migrate to |
From: <si...@us...> - 2006-08-09 04:20:51
|
User: sits Date: 06/08/08 21:20:48 Modified: doc codestriker.sgml Log: Make the section IDs docbook compliant - all looks good now Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.63 retrieving revision 1.64 diff -u -r1.63 -r1.64 --- codestriker.sgml 9 Aug 2006 03:57:35 -0000 1.63 +++ codestriker.sgml 9 Aug 2006 04:20:48 -0000 1.64 @@ -1079,7 +1079,7 @@ Perl is available by default for all UNIX systems. For Windows, you can download it for free from <ulink url="http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl">http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl</ulink>. Note if you are using IIS as your web-server, please - see <xref linkend="IIS configuration"> on appropriate ActivePerl releases. + see <xref linkend="IIS-configuration"> on appropriate ActivePerl releases. </para> <para> To run <filename>install.pl</filename> under UNIX, do the @@ -1320,7 +1320,7 @@ </sect2> </sect1> - <sect1 id="IIS configuration"> + <sect1 id="IIS-configuration"> <title>IIS configuration</title> <para> This section deals with deploying Codestriker under IIS, as |
From: <si...@us...> - 2008-02-23 02:17:22
|
User: sits Date: 08/02/22 18:17:15 Modified: doc codestriker.sgml Log: Commit Rob's documentation changes Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.66 retrieving revision 1.67 diff -u -r1.66 -r1.67 --- codestriker.sgml 7 Jun 2007 04:46:27 -0000 1.66 +++ codestriker.sgml 23 Feb 2008 02:17:15 -0000 1.67 @@ -3,9 +3,9 @@ <book> <bookinfo> <title>The Codestriker Guide</title> - <subtitle>Version 1.9.3</subtitle> + <subtitle>Version 1.9.5</subtitle> <legalnotice> - <para>Copyright (c) 2001 - 2007</para> + <para>Copyright (c) 2001 - 2008</para> </legalnotice> <authorgroup> <author> @@ -629,16 +629,14 @@ been resolved, Codestriker can add in a link to the code review topic, which shows the actual code which fixed the bug (and any important decisions made in the Codestriker - comments). Currently, there is support for Bugzilla and Flyspray, - but it is not difficult to add in support for other systems. + comments). Currently, there is support for Bugzilla, Flyspray + and TestDirector, but it is not difficult to add in support + for other systems. </para> <para> - If you don't use Bugzilla (<ulink - url="http://bugzilla.mozilla.org">http://bugzilla.mozilla.org</ulink>) - or Flyspray, - you can skip this section, as by default, there is no - linking to a bug tracking system. An example configuration - could be as follows: + If you don't use a bugtracker you can skip this section, + as by default, there is no linking to a bug tracking system. + An example configuration could be as follows: <programlisting> # Bug tracking type. $bug_db = 'bugzilla'; @@ -1059,6 +1057,33 @@ added to the system. </para> </sect2> + <sect2> + <title>Scmbug Integration</title> + <para> + It is possible for Codestriker to integrate with ScmBug + (<ulink url="http://www.mkgnu.net/?q=scmbug">http://www.mkgnu.net/?q=scmbug</ulink>). + This allows users to generate a topic based on the changes + done under a given bug ID (or list of bug IDs). An example + configuration is: +<programlisting> +$scmbug_hostname = 'localhost'; +$scmbug_port = 3872; +$scmbug_lib_dir = 'C:/Program Files/Scmbug/share/scmbug/lib'; +</programlisting> + </para> + <para> + This would match the default settings used by Scmbug on + Windows. Where <varname>$scmbug_hostname</varname> and + <varname>$scmbug_port</varname> are the host + and port of the machine where Scmbug is running. The + <varname>$scmbug_lib_dir</varname> points to the lib + directory under the Scmbug installation. If Scmbug is + running on a separate machine a copy of the Scmbug lib + directory needs to be staged on the same machine as + codestriker and the <varname>$scmbug_lib_dir</varname> + variable made to point at this. + </para> + </sect2> </sect1> <sect1 id="running-install.pl"> @@ -1991,6 +2016,17 @@ which would work on all files located within that path. </para> </sect2> + <sect2> + <title>Creating Topics from Bug IDs</title> + <para> + If you have Codestriker configured to make use of Scmbug + integration it is possible to generate a Topic by entering a + list of bug IDs (comma separated). To generate the topic in + this way, ensure that the Start Tag, End Tag and Module + fields are left blank and that the relevant bug IDs are + entered into the Bug IDs field. + </para> + </sect2> </sect1> <sect1> <title>Reviewing Topics</title> |
From: <si...@us...> - 2008-06-24 03:16:20
|
User: sits Date: 08/06/23 20:16:16 Modified: doc codestriker.sgml Log: Updated documentation. Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.67 retrieving revision 1.68 diff -u -r1.67 -r1.68 --- codestriker.sgml 23 Feb 2008 02:17:15 -0000 1.67 +++ codestriker.sgml 24 Jun 2008 03:16:16 -0000 1.68 @@ -889,28 +889,17 @@ </para> </sect2> <sect2> - <title>Default View Topic Line Break Mode</title> + <title>Source Code Hihglighting</title> <para> - As explained by the comments in the configuration file, it - is possible to set the default view topic line break mode, - by setting the <varname>$default_topic_br_mode</varname> - variable. There is usually no need to change the default - setting unless you regularly review code with very long - lines. + Source code highlighting will be performed if the Highlight + program is installed. <programlisting> -# The default line break viewing mode to use in the URL when viewing a -# topic. Can be either $LINE_BREAK_NORMAL_MODE or $LINE_BREAK_ASSIST_MODE. -# Using $LINE_BREAK_ASSIST_MODE indicates that extra line breaks may be -# used in the topic display if the review has very long code lines. Using -# $LINE_BREAK_NORMAL_MODE will ensure that the display matches the line -# breaks present in the code. The line break mode can also be changed -# dynamically in the view topic screen. There is usually no need to -# change this setting unless you regularly review code with very long -# lines. -$LINE_BREAK_NORMAL_MODE = 1; -$LINE_BREAK_ASSIST_MODE = 2; - -$default_topic_br_mode = $LINE_BREAK_NORMAL_MODE; +# Location of the highlight binary, which is used for highlighting source code. +# Available from http://www.andre-simon.de/. If this is not set, no syntax +# highlighting will be performed. +$highlighter = ''; +#$highlighter = '/usr/bin/highlight'; +#$highlighter = 'C:/Program Files (x86)/WinHighlight/highlight.exe'; </programlisting> </para> </sect2> @@ -1920,6 +1909,12 @@ Here 132 is the change-number. This should be substituted with the change-number that you want to review. </para> + <para> + It is also possible to create Perforce topics from already committed + code. Simply enter the change number into either the "Start tag" or + "End tag" field, and set "Module" to be //, which corresponds to the + root of the depot. + </para> </sect2> <sect2> <title>Creating ClearCase Diff Topics</title> |
From: <si...@us...> - 2008-08-08 06:10:14
|
User: sits Date: 08/08/07 23:10:13 Modified: doc codestriker.sgml Log: Added little snippet about using Subversion post-commit hook. Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.68 retrieving revision 1.69 diff -u -r1.68 -r1.69 --- codestriker.sgml 24 Jun 2008 03:16:16 -0000 1.68 +++ codestriker.sgml 8 Aug 2008 06:10:13 -0000 1.69 @@ -1884,6 +1884,16 @@ repository location. All topics created by Codestriker have a builtin workaround for the Subversion diff problem. </para> + <para> + It is possible to create Codestriker topics automatically after + each Subversion commit, via the bin/subversion-post-commit.pl script. + Once the appropriate configuration is set at the start of the file, simply + add it to your Subversion <filename>repos/hooks/post-commit</filename> + the path to the file as follows: +<programlisting> + /path/to/codestriker/bin/subversion-post-commit.pl "$REPOS" "$REV" +</programlisting> + </para> </sect2> <sect2> <title>Creating Perforce Diff Topics</title> |
From: <si...@us...> - 2008-09-27 03:29:06
|
User: sits Date: 08/09/26 20:28:56 Modified: template/en/default viewtopicproperties.html.tmpl viewtopicinfo.html.tmpl viewtopicfile.html.tmpl viewtopiccomments.html.tmpl viewtopic.html.tmpl submitnewtopic.html.tmpl submitnewcomment.html.tmpl search.html.tmpl metricsreport.html.tmpl listtopics.html.tmpl listprojects.html.tmpl header.html.tmpl editproject.html.tmpl editcomment.html.tmpl createtopic.html.tmpl createproject.html.tmpl doc codestriker.sgml Log: Remove "Help" links to specific parts of the manual. It was a pain to update these links whenever the manual changed. Just point to the start of the manual for each page instead. Index: viewtopicproperties.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/viewtopicproperties.html.tmpl,v retrieving revision 1.30 retrieving revision 1.31 diff -u -r1.30 -r1.31 --- viewtopicproperties.html.tmpl 29 Aug 2008 10:49:00 -0000 1.30 +++ viewtopicproperties.html.tmpl 27 Sep 2008 03:28:56 -0000 1.31 @@ -4,8 +4,7 @@ properties can be modified on this page. #%] [% PROCESS viewtopicheader.html.tmpl version = version topicview = 0 - topiccomments = 0 topicinfo = 0 topicproperties = 1 closehead = 1 - help = "x639.html" %] + topiccomments = 0 topicinfo = 0 topicproperties = 1 closehead = 1 %] <script type="text/javascript"> <!-- Index: viewtopicinfo.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/viewtopicinfo.html.tmpl,v retrieving revision 1.26 retrieving revision 1.27 diff -u -r1.26 -r1.27 --- viewtopicinfo.html.tmpl 29 Aug 2008 10:49:00 -0000 1.26 +++ viewtopicinfo.html.tmpl 27 Sep 2008 03:28:56 -0000 1.27 @@ -3,8 +3,7 @@ [% USE AutomagicLinks %] [% PROCESS viewtopicheader.html.tmpl version = version topicview = 0 - topicproperties = 0 topiccomments = 0 topicinfo = 1 closehead = 1 - help = "x652.html" %] + topicproperties = 0 topiccomments = 0 topicinfo = 1 closehead = 1 %] [%# Create a form to allow the topic's metrics to be changed #%] [% SET metric_input_exists = 0 %] Index: viewtopicfile.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/viewtopicfile.html.tmpl,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- viewtopicfile.html.tmpl 8 Aug 2008 07:02:09 -0000 1.4 +++ viewtopicfile.html.tmpl 27 Sep 2008 03:28:56 -0000 1.5 @@ -1,6 +1,6 @@ [%# Screen for displaying a complete file from a topic. #%] -[% PROCESS header.html.tmpl version = version displaymenu = 1 help = "x519.html#VIEW-FILE" +[% PROCESS header.html.tmpl version = version displaymenu = 1 closehead = 1 subtitle = "View Topic File" %] [% PROCESS viewdeltas.html.tmpl deltas = deltas %] Index: viewtopiccomments.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/viewtopiccomments.html.tmpl,v retrieving revision 1.31 retrieving revision 1.32 diff -u -r1.31 -r1.32 --- viewtopiccomments.html.tmpl 31 Aug 2008 11:45:04 -0000 1.31 +++ viewtopiccomments.html.tmpl 27 Sep 2008 03:28:56 -0000 1.32 @@ -4,7 +4,7 @@ [% USE FormatWhitespace tabwidth = tabwidth %] [% PROCESS viewtopicheader.html.tmpl version = version - help = "x617.html" topicview = 0 topicproperties = 0 topiccomments = 1 + topicview = 0 topicproperties = 0 topiccomments = 1 topicinfo = 0 closehead = 1 %] <SCRIPT type="text/javascript"> Index: viewtopic.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/viewtopic.html.tmpl,v retrieving revision 1.54 retrieving revision 1.55 diff -u -r1.54 -r1.55 --- viewtopic.html.tmpl 8 Aug 2008 07:02:08 -0000 1.54 +++ viewtopic.html.tmpl 27 Sep 2008 03:28:56 -0000 1.55 @@ -2,7 +2,7 @@ <body onload="view_topic_on_load_handler();"> [% PROCESS viewtopicheader.html.tmpl version = version - help = "x519.html#VIEW-TOPIC" topicview = 1 topicproperties = 0 + topicview = 1 topicproperties = 0 topiccomments = 0 topicinfo = 0 closehead = 0 %] <p> Index: submitnewtopic.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/submitnewtopic.html.tmpl,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- submitnewtopic.html.tmpl 23 Jun 2008 10:12:16 -0000 1.8 +++ submitnewtopic.html.tmpl 27 Sep 2008 03:28:56 -0000 1.9 @@ -1,7 +1,7 @@ [%# Screen for the submit topic confirmation screen. #%] [% PROCESS header.html.tmpl version = version displaymenu = 1 - closehead = 1 help="" subtitle = "Topic Created" %] + closehead = 1 subtitle = "Topic Created" %] [%# Display any "feedback" to the user if necessary. #%] [% IF feedback != '' %] Index: submitnewcomment.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/submitnewcomment.html.tmpl,v retrieving revision 1.9 retrieving revision 1.10 diff -u -r1.9 -r1.10 --- submitnewcomment.html.tmpl 23 Jun 2008 10:12:16 -0000 1.9 +++ submitnewcomment.html.tmpl 27 Sep 2008 03:28:56 -0000 1.10 @@ -1,7 +1,7 @@ [%# Screen for the submit comment confirmation screen. #%] [% PROCESS header.html.tmpl version = version displaymenu = 1 - closehead = 1 help="" subtitle = "Comment Submitted" %] + closehead = 1 subtitle = "Comment Submitted" %] <PRE>[% comment | html_entity %] </PRE><P><P> Index: search.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/search.html.tmpl,v retrieving revision 1.38 retrieving revision 1.39 diff -u -r1.38 -r1.39 --- search.html.tmpl 31 Aug 2008 12:02:12 -0000 1.38 +++ search.html.tmpl 27 Sep 2008 03:28:56 -0000 1.39 @@ -1,7 +1,7 @@ [%# Screen for search topics. #%] [% PROCESS header.html.tmpl version = version displaymenu = 1 - closehead = 1 help = "x671.html" subtitle = "Find Topics" %] + closehead = 1 subtitle = "Find Topics" %] <FORM METHOD="post" ENCTYPE="application/x-www-form-urlencoded" ACTION="[% action_url %]"> Index: metricsreport.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/metricsreport.html.tmpl,v retrieving revision 1.22 retrieving revision 1.23 diff -u -r1.22 -r1.23 --- metricsreport.html.tmpl 8 Aug 2008 07:02:08 -0000 1.22 +++ metricsreport.html.tmpl 27 Sep 2008 03:28:56 -0000 1.23 @@ -1,7 +1,7 @@ [%# Screen for the metrics report. #%] [% PROCESS header.html.tmpl version = version displaymenu = 1 - closehead = 1 help ="x707.html" subtitle = "Metrics Report" %] + closehead = 1 subtitle = "Metrics Report" %] <!-- "" --> Index: listtopics.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/listtopics.html.tmpl,v retrieving revision 1.45 retrieving revision 1.46 diff -u -r1.45 -r1.46 --- listtopics.html.tmpl 6 Sep 2008 03:31:08 -0000 1.45 +++ listtopics.html.tmpl 27 Sep 2008 03:28:56 -0000 1.46 @@ -1,7 +1,7 @@ [%# Screen for show a list of topics. #%] [% PROCESS header.html.tmpl version = version displaymenu = 1 - closehead = 1 help = "x347.html" subtitle = "Topic List" %] + closehead = 1 subtitle = "Topic List" %] [%# Display any "feedback" to the user if necessary. #%] [% IF feedback != '' %] Index: listprojects.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/listprojects.html.tmpl,v retrieving revision 1.26 retrieving revision 1.27 diff -u -r1.26 -r1.27 --- listprojects.html.tmpl 24 Jun 2008 03:26:50 -0000 1.26 +++ listprojects.html.tmpl 27 Sep 2008 03:28:56 -0000 1.27 @@ -1,7 +1,7 @@ [%# Display a list of projects #%] [% PROCESS header.html.tmpl version = version displaymenu = 1 - closehead = 1 help = "x378.html" subtitle="Project List" %] + closehead = 1 subtitle="Project List" %] [%# Display any "feedback" to the user if necessary. #%] [% IF feedback != '' %] Index: header.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/header.html.tmpl,v retrieving revision 1.18 retrieving revision 1.19 diff -u -r1.18 -r1.19 --- header.html.tmpl 8 Sep 2008 06:49:37 -0000 1.18 +++ header.html.tmpl 27 Sep 2008 03:28:56 -0000 1.19 @@ -19,7 +19,7 @@ | <a href="[% create_topic_url | html_entity %]">Create new topic</a> [% IF searchlist_enabled != 0 %] | <a href="[% search_url | html_entity %]">Search</a> [% END %] [% IF login_url != "" %] | <a href="[% login_url %]">Log In</a>[% END %] - [% IF help != "" %] | <a href="[% doc_url | html_entity %]/[% help %]">Help</a>[% END %] + | <a href="[% doc_url | html_entity %]/codestriker.html">Manual</a> </div> [% END %] </div> Index: editproject.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/editproject.html.tmpl,v retrieving revision 1.27 retrieving revision 1.28 diff -u -r1.27 -r1.28 --- editproject.html.tmpl 24 Jun 2008 03:26:50 -0000 1.27 +++ editproject.html.tmpl 27 Sep 2008 03:28:56 -0000 1.28 @@ -1,7 +1,7 @@ [%# Screen for the edit project form. #%] [% PROCESS header.html.tmpl version = version displaymenu = 1 - closehead = 1 help = "x378.html" subtitle = "Edit Project" %] + closehead = 1 subtitle = "Edit Project" %] <script language="JavaScript"> Index: editcomment.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/editcomment.html.tmpl,v retrieving revision 1.28 retrieving revision 1.29 diff -u -r1.28 -r1.29 --- editcomment.html.tmpl 29 Aug 2008 10:48:59 -0000 1.28 +++ editcomment.html.tmpl 27 Sep 2008 03:28:56 -0000 1.29 @@ -118,7 +118,7 @@ [%# Screen for the add comment form. #%] -[% PROCESS header.html.tmpl displaymenu = 0 version = version help = "x519.html#ADD-COMMENT" subtitle = "Add Comment" %] +[% PROCESS header.html.tmpl displaymenu = 0 version = version subtitle = "Add Comment" %] <table border="0" cellpadding="5" cellspacing="0" width="100%"> <tr class="tlh"> Index: createtopic.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/createtopic.html.tmpl,v retrieving revision 1.60 retrieving revision 1.61 diff -u -r1.60 -r1.61 --- createtopic.html.tmpl 25 Sep 2008 00:16:10 -0000 1.60 +++ createtopic.html.tmpl 27 Sep 2008 03:28:56 -0000 1.61 @@ -1,7 +1,7 @@ [%# Screen for the create topic form. #%] [% PROCESS header.html.tmpl version = version displaymenu = 1 - closehead = 1 help = "x402.html" subtitle = "Create New Topic" %] + closehead = 1 subtitle = "Create New Topic" %] [%# Display any "feedback" to the user if necessary. #%] [% IF feedback != '' %] Index: createproject.html.tmpl =================================================================== RCS file: /cvsroot/codestriker/codestriker/template/en/default/createproject.html.tmpl,v retrieving revision 1.26 retrieving revision 1.27 diff -u -r1.26 -r1.27 --- createproject.html.tmpl 24 Jun 2008 03:26:50 -0000 1.26 +++ createproject.html.tmpl 27 Sep 2008 03:28:56 -0000 1.27 @@ -1,7 +1,7 @@ [%# Screen for the create project form. #%] [% PROCESS header.html.tmpl version = version displaymenu = 1 - closehead = 1 help = "x378.html" subtitle = "Create new Project" %] + closehead = 1 subtitle = "Create new Project" %] [%# Display any "feedback" to the user if necessary. #%] [% IF feedback != '' %] Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.72 retrieving revision 1.73 diff -u -r1.72 -r1.73 --- codestriker.sgml 9 Sep 2008 22:45:44 -0000 1.72 +++ codestriker.sgml 27 Sep 2008 03:28:56 -0000 1.73 @@ -1892,10 +1892,7 @@ file (although the patch segments can still be reviewed). If you commit your code first, then let Codestriker make the diff, as explained in the next section, then you can avoid - this limitation. If you really don't want to commit your - code, you will need to modify the diff file to include the - paths on the Index: +++, and --- lines generated by - <command>svn diff</command>. + this limitation. </para> <para> In some development processes, branches are used as the |
From: <si...@us...> - 2008-09-27 04:28:19
|
User: sits Date: 08/09/26 21:28:08 Modified: doc codestriker.sgml Log: Add gotcha for using ScmBug with inetd. Index: codestriker.sgml =================================================================== RCS file: /cvsroot/codestriker/codestriker/doc/codestriker.sgml,v retrieving revision 1.73 retrieving revision 1.74 diff -u -r1.73 -r1.74 --- codestriker.sgml 27 Sep 2008 03:28:56 -0000 1.73 +++ codestriker.sgml 27 Sep 2008 04:28:07 -0000 1.74 @@ -1077,6 +1077,14 @@ codestriker and the <varname>$scmbug_lib_dir</varname> variable made to point at this. </para> + <para> + Using ScmBug for creating topics can generate a very large + number of requests to your SCM system. If your SCM system + is running under a Unix system, you might need to increase + the number of allowed requests per-minute in your inetd + configuration, otherwise you might experience hangs while + creating ScmBug topics. + </para> </sect2> </sect1> |