Subversion Repositories DevTools

Rev

Rev 1295 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1293 dpurdie 1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
2 
<HTML
3 
><HEAD
4 
><TITLE
5 
>Introduction</TITLE
6 
><META
7 
NAME="GENERATOR"
8 
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9 
REL="HOME"
10 
TITLE="The Codestriker Guide"
11 
HREF="book1.html"><LINK
12 
REL="PREVIOUS"
13 
TITLE="The Codestriker Guide"
14 
HREF="book1.html"><LINK
15 
REL="NEXT"
16 
TITLE="Document Structure"
17 
HREF="x41.html"></HEAD
18 
><BODY
19 
CLASS="CHAPTER"
20 
BGCOLOR="#FFFFFF"
21 
TEXT="#000000"
22 
LINK="#0000FF"
23 
VLINK="#840084"
24 
ALINK="#0000FF"
25 
><DIV
26 
CLASS="NAVHEADER"
27 
><TABLE
28 
SUMMARY="Header navigation table"
29 
WIDTH="100%"
30 
BORDER="0"
31 
CELLPADDING="0"
32 
CELLSPACING="0"
33 
><TR
34 
><TH
35 
COLSPAN="3"
36 
ALIGN="center"
37 
>The Codestriker Guide: Version 1.9.3</TH
38 
></TR
39 
><TR
40 
><TD
41 
WIDTH="10%"
42 
ALIGN="left"
43 
VALIGN="bottom"
44 
><A
45 
HREF="book1.html"
46 
ACCESSKEY="P"
47 
>Prev</A
48 
></TD
49 
><TD
50 
WIDTH="80%"
51 
ALIGN="center"
52 
VALIGN="bottom"
53 
></TD
54 
><TD
55 
WIDTH="10%"
56 
ALIGN="right"
57 
VALIGN="bottom"
58 
><A
59 
HREF="x41.html"
60 
ACCESSKEY="N"
61 
>Next</A
62 
></TD
63 
></TR
64 
></TABLE
65 
><HR
66 
ALIGN="LEFT"
67 
WIDTH="100%"></DIV
68 
><DIV
69 
CLASS="CHAPTER"
70 
><H1
71 
><A
72 
NAME="AEN12"
73 
></A
74 
>Chapter 1. Introduction</H1
75 
><DIV
76 
CLASS="TOC"
77 
><DL
78 
><DT
79 
><B
80 
>Table of Contents</B
81 
></DT
82 
><DT
83 
>1.1. <A
84 
HREF="c12.html#AEN14"
85 
>What is Codestriker?</A
86 
></DT
87 
><DT
88 
>1.2. <A
89 
HREF="x41.html"
90 
>Document Structure</A
91 
></DT
92 
><DT
93 
>1.3. <A
94 
HREF="x44.html"
95 
>We Want to Hear from You!</A
96 
></DT
97 
></DL
98 
></DIV
99 
><DIV
100 
CLASS="SECT1"
101 
><H1
102 
CLASS="SECT1"
103 
><A
104 
NAME="AEN14"
105 
>1.1. What is Codestriker?</A
106 
></H1
107 
><P
108 
>        Codestriker is a web application which facilitates
109 
        collaborative code reviewing.  Authors create code review
110 
        topics, where the nominated reviewers will be automatically
111 
        notified by email.  Reviewers then submit comments against the
112 
        code on a per-line basis, and can also view comments submitted
113 
        by the other reviewers as they are created.  Emails are sent
114 
        to the appropriate parties when comments are created, as an
115 
        alert mechanism.  The author is also free to submit comments
116 
        against the review comments.  Once all reviewers have
117 
        finished, the author has all review comments available in a
118 
        structured fashion.  All information is stored in a relational
119 
        database, which Codestriker can search over.  All text is
120 
        stored internally as UTF-8, which supports reviews in
121 
        all major languages.
122 
      </P
123 
><P
124 
>        Special support is provided for integration with
125 
	<A
126 
HREF="http://cvshome.org"
127 
TARGET="_top"
128 
>CVS</A
129 
>,
130 
	<A
131 
HREF="http://subversion.tigris.org"
132 
TARGET="_top"
133 
>Subversion</A
134 
>,
135 
	<A
136 
HREF="http://www.perforce.com"
137 
TARGET="_top"
138 
>Perforce</A
139 
>,
140 
	<A
141 
HREF="http://www.ibm.com/software/awdtools/clearcase"
142 
TARGET="_top"
143 
>ClearCase</A
144 
>
145 
	and
146 
	<A
147 
HREF="http://msdn.microsoft.com/ssafe"
148 
TARGET="_top"
149 
>Visual SourceSafe</A
150 
>.
151 
	 source control management systems, for the display of
152 
	 coloured diffs and for the ability to view original and new
153 
	 files in their entirety to assist in the review process.
154 
	 Codestriker can be optionally linked with a bug tracking
155 
	 system, such as Bugzilla.  Other SCM systems will be added in
156 
	 future releases, given demand and help from the developer
157 
	 community.  Codestriker can also be linked with
158 
	<A
159 
HREF="http://lxr.sourceforge.net"
160 
TARGET="_top"
161 
>LXR</A
162 
> to allow
163 
	for fast lookup of code entities, to assist in the review
164 
	process.
165 
      </P
166 
><P
167 
>        Codestriker is written in cross-platform Perl.  It
168 
        can run on any variant of UNIX (Linux, *BSD) and has been
169 
        deployed on Win32 systems (Windows 98 and above).  It can be
170 
        used in conjunction with a number of relational databases,
171 
        including MySQL, PostgreSQL, Oracle, SQL Server, and other
172 
        ODBC-compliant databases.
173 
        The Codestriker home page is located at:
174 
	<A
175 
HREF="http://codestriker.sourceforge.net"
176 
TARGET="_top"
177 
>http://codestriker.sourceforge.net</A
178 
>.
179 
	The Codestriker SourceForge project page, which contains
180 
	information on file releases, defect lists, mailing lists and
181 
	information on the CVS repository is located at
182 
	<A
183 
HREF="http://www.sourceforge.net/projects/codestriker"
184 
TARGET="_top"
185 
>http://www.sourceforge.net/projects/codestriker</A
186 
>.
187 
      </P
188 
><P
189 
>        An example Codestriker topic can be seen at
190 
	<A
191 
HREF="http://codestriker.sourceforge.net/cgi-bin/codestriker.pl?topic=7063366&#38;action=view"
192 
TARGET="_top"
193 
>http://codestriker.sourceforge.net/cgi-bin/codestriker.pl?topic=7063366&amp;action=view</A
194 
>.
195 
	To view the current list of open topics, go to <A
196 
HREF="http://codestriker.sourceforge.net/cgi-bin/codestriker.pl"
197 
TARGET="_top"
198 
>http://codestriker.sourceforge.net/cgi-bin/codestriker.pl</A
199 
>.
200 
	From here, there are links to create new topics.
201 
      </P
202 
><P
203 
>        This document is available as a PDF:
204 
	<A
205 
HREF="codestriker.pdf"
206 
TARGET="_top"
207 
>codestriker.pdf</A
208 
>.
209 
      </P
210 
><P
211 
>        A screenshot of Codestriker is action can be seen in <A
212 
HREF="c12.html#SCREENSHOT"
213 
>Figure 1-1</A
214 
>.
215 
	<DIV
216 
CLASS="FIGURE"
217 
><A
218 
NAME="SCREENSHOT"
219 
></A
220 
><P
221 
><B
222 
>Figure 1-1. Codestriker Screenshot</B
223 
></P
224 
><DIV
225 
CLASS="MEDIAOBJECT"
226 
><P
227 
><IMG
228 
SRC="screenshot.png"></P
229 
></DIV
230 
></DIV
231 
>
232 
      </P
233 
></DIV
234 
></DIV
235 
><DIV
236 
CLASS="NAVFOOTER"
237 
><HR
238 
ALIGN="LEFT"
239 
WIDTH="100%"><TABLE
240 
SUMMARY="Footer navigation table"
241 
WIDTH="100%"
242 
BORDER="0"
243 
CELLPADDING="0"
244 
CELLSPACING="0"
245 
><TR
246 
><TD
247 
WIDTH="33%"
248 
ALIGN="left"
249 
VALIGN="top"
250 
><A
251 
HREF="book1.html"
252 
ACCESSKEY="P"
253 
>Prev</A
254 
></TD
255 
><TD
256 
WIDTH="34%"
257 
ALIGN="center"
258 
VALIGN="top"
259 
><A
260 
HREF="book1.html"
261 
ACCESSKEY="H"
262 
>Home</A
263 
></TD
264 
><TD
265 
WIDTH="33%"
266 
ALIGN="right"
267 
VALIGN="top"
268 
><A
269 
HREF="x41.html"
270 
ACCESSKEY="N"
271 
>Next</A
272 
></TD
273 
></TR
274 
><TR
275 
><TD
276 
WIDTH="33%"
277 
ALIGN="left"
278 
VALIGN="top"
279 
>The Codestriker Guide</TD
280 
><TD
281 
WIDTH="34%"
282 
ALIGN="center"
283 
VALIGN="top"
284 
>&nbsp;</TD
285 
><TD
286 
WIDTH="33%"
287 
ALIGN="right"
288 
VALIGN="top"
289 
>Document Structure</TD
290 
></TR
291 
></TABLE
292 
></DIV
293 
></BODY
294 
></HTML
295 
>