[Codestriker-commits] CVS update: codestriker/doc codestriker.sgml
Brought to you by:
sits
|
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>
|