gnugo-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[gnugo-devel] documentation maintenance


From: Paul Pogonyshev
Subject: [gnugo-devel] documentation maintenance
Date: Sat, 9 Apr 2005 22:57:19 +0300
User-agent: KMail/1.4.3

Use proper capitalization: ``GNU Go'', ``GDB'', ``DFA''.


Index: dfa.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/dfa.texi,v
retrieving revision 1.6
diff -u -p -r1.6 dfa.texi
--- dfa.texi    6 Jul 2003 14:31:54 -0000       1.6
+++ dfa.texi    9 Apr 2005 19:51:07 -0000
@@ -1,4 +1,4 @@
-In this chapter, we describe the principles of the gnugo DFA
+In this chapter, we describe the principles of the GNU Go DFA
 pattern matcher.  The aim of this system is to permit a fast
 pattern matching when it becomes time critical like in owl
 module (@ref{The Owl Code}). Since GNU Go 3.2, this is enabled
@@ -17,7 +17,7 @@ compile time.
 @menu
 * Introduction to the DFA::  Scanning the board along a path
 * What is a DFA:: A recall of language theory.
-* Pattern matching with DFA:: How to retrieve go patterns with a dfa ?
+* Pattern matching with DFA:: How to retrieve go patterns with a DFA?
 * Building the DFA:: Playing with explosives.
 * Incremental Algorithm:: The joy of determinism.
 * DFA Optimizations:: Some possible optimizations.
@@ -126,11 +126,11 @@ of pattern matching algorithms).
 Basically, 
 a DFA is a set of @dfn{states} connected by labeled @dfn{transitions}.
 The labels are the values read on the board,
-in gnugo these values are EMPTY, WHITE, BLACK or OUT_BOARD, denoted
+in GNU Go these values are EMPTY, WHITE, BLACK or OUT_BOARD, denoted
 respectively by '.','O','X' and '#'.
 
 
-The best way to represent a dfa is to draw its transition graph:
+The best way to represent a DFA is to draw its transition graph:
 the pattern @b{"????..X"} is recognized by the following DFA:
 
 @ifinfo
@@ -280,7 +280,7 @@ the size of the biggest pattern.
 
 Here is an example of scan:
 
-First we build a minimal dfa recognizing these patterns:
+First we build a minimal DFA recognizing these patterns:
 @b{"X..X"}, @b{"X???"}, @b{"X.OX"} and @b{"X?oX"}.
 Note that wildcards like '?','o', or 'x' give multiple out-transitions.
 
@@ -386,8 +386,8 @@ It is possible to construct a special pa
 generates an "explosive" automaton: the size of the DFA is in
 the worst case exponential in the number of patterns it
 recognizes.  But it doesn't occur in pratical situations: 
-the dfa size tends to be @dfn{stable}.  By @dfn{stable} we mean that if we
-add a pattern which greatly increases the size of the dfa it
+the DFA size tends to be @dfn{stable}.  By @dfn{stable} we mean that if we
+add a pattern which greatly increases the size of the DFA it
 also increases the chance that the next added pattern does not
 increase its size at all.  Nevertheless there are many ways to
 reduce the size of the DFA. Good compression methods are
@@ -399,7 +399,7 @@ DFA-based pattern matchers}.
 @section Incremental Algorithm
 
 The incremental version of the DFA pattern matcher is not yet implemented
-in gnugo but we explain here how it will work.
+in GNU Go but we explain here how it will work.
 By definition of a deterministic automaton, scanning the same
 string will reach the same states every time.
 
@@ -432,7 +432,7 @@ top_stack[i][j]. This should speedup a l
 @node DFA Optimizations
 @section Some DFA Optimizations
 
-The dfa is constructed to minimize jumps in memory making some
+The DFA is constructed to minimize jumps in memory making some
 assumptions about the frequencies of the values: the EMPTY
 value is supposed to appear often on the board, so the the '.'
 transition are almost always successors in memory.  The
Index: install.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/install.texi,v
retrieving revision 1.19
diff -u -p -r1.19 install.texi
--- install.texi        26 Oct 2004 14:18:10 -0000      1.19
+++ install.texi        9 Apr 2005 19:51:11 -0000
@@ -47,7 +47,7 @@ After running configure and make, you ha
 @end example
 
 @noindent
-to install gnugo in @file{/usr/local/bin}.
+to install @file{gnugo} in @file{/usr/local/bin}.
 
 There are different methods of using GNU Go. You may run it from the
 command line by just typing:
@@ -119,10 +119,11 @@ cache size will be 8 MB. You must recomp
 GNU Go after reconfiguring it by running @command{make} and
 @command{make install}.
 
-You may override the compile-time defaults by running gnugo with the
-option @option{--cache-size n}, where @code{n} is the size in
+You may override the compile-time defaults by running @file{gnugo}
+with the option @option{--cache-size n}, where @code{n} is the size in
 megabytes of the cache you want, and @option{--level} where n is the
-level desired.  We will discuss setting these parameters next in detail.
+level desired.  We will discuss setting these parameters next in
+detail.
 
 @node Default Level
 @subsection Default Level
@@ -260,7 +261,7 @@ high quality free Unix-environments for 
 are available.
 
 One benefit of this approach is that it is easier to
-participate in Gnu Go's development. These unix environments
+participate in GNU Go's development. These unix environments
 come for instance with the `diff' and `patch' programs
 necessary to generate and apply patches.
 
@@ -308,7 +309,7 @@ DJGPP ftp archive on simtel:
 @url{ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/}
 
 Once you have a working DJGPP environment and you have downloaded
-the gnugo source available as gnugo-3.6.tar.gz you can build the
+the GNU Go source available as gnugo-3.6.tar.gz you can build the
 executable as follows:
 
 @example
Index: overview.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/overview.texi,v
retrieving revision 1.22
diff -u -p -r1.22 overview.texi
--- overview.texi       25 Oct 2004 01:06:22 -0000      1.22
+++ overview.texi       9 Apr 2005 19:51:25 -0000
@@ -796,10 +796,10 @@ levels of tracing. You can set the trace
 the command line by @option{-t} for @code{verbose=1}, 
 @option{-t -t} for @code{verbose=2}, etc. But in
 practice if you want more verbose tracing than level
-1 it is better to use gdb to reach the point where
+1 it is better to use GDB to reach the point where
 you want the tracing; you will often find that the
 variable @code{verbose} has been temporarily set to zero
-and you can use the gdb command @command{set var verbose=1}
+and you can use the GDB command @command{set var verbose=1}
 to turn the tracing back on.
 
 @subsection Assertions
Index: patterns.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/patterns.texi,v
retrieving revision 1.18
diff -u -p -r1.18 patterns.texi
--- patterns.texi       16 Apr 2004 16:21:46 -0000      1.18
+++ patterns.texi       9 Apr 2005 19:51:25 -0000
@@ -1395,7 +1395,7 @@ there are implementation details which o
 
 In GNU Go, the ascii @file{.db} files are precompiled into tables (see
 @file{patterns.h}) by a standalone program @file{mkpat.c}, and the resulting 
address@hidden files are compiled and linked into the main gnugo executable.
address@hidden files are compiled and linked into the main GNU Go executable.
 
 Each pattern is compiled to a header, and a sequence of elements,
 which are (notionally) checked sequentially at every position and
@@ -1592,7 +1592,7 @@ at a time.
 @section The Joseki Compiler
 
 @cindex joseki
address@hidden how gnugo learn new joseki
address@hidden how GNU Go learns new joseki
 @cindex the joseki compiler
 @cindex teaching josekis to GNU Go
 
Index: reading.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/reading.texi,v
retrieving revision 1.19
diff -u -p -r1.19 reading.texi
--- reading.texi        25 Oct 2004 01:06:22 -0000      1.19
+++ reading.texi        9 Apr 2005 19:51:39 -0000
@@ -1035,7 +1035,7 @@ Other commands defined in this file:
 
 @example
 
address@hidden gnugo's gdb commands 
address@hidden GNU Go's GDB commands 
 
 @command{dump} will print the move stack.
 @command{nv} moves to the next variation
Index: using.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/using.texi,v
retrieving revision 1.27
diff -u -p -r1.27 using.texi
--- using.texi  19 Jan 2005 23:52:55 -0000      1.27
+++ using.texi  9 Apr 2005 19:51:39 -0000
@@ -65,9 +65,9 @@ beautiful graphic user interface under X
 Start CGoban. When the CGoban Control panel comes up, select ``Go
 Modem''. You will get the Go Modem Protocol Setup. Choose one (or
 both) of the players to be ``Program,'' and fill out the box with the
-path to gnugo. After clicking OK, you get the Game Setup window.
-Choose ``Rules Set'' to be Japanese (otherwise handicaps won't work).
-Set the board size and handicap if you want.
+path to @file{gnugo}. After clicking OK, you get the Game Setup
+window.  Choose ``Rules Set'' to be Japanese (otherwise handicaps
+won't work).  Set the board size and handicap if you want.
 
 If you want to play with a komi, you should bear in mind that
 the GMP does not have any provision for communicating the komi.
Index: utils.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/utils.texi,v
retrieving revision 1.18
diff -u -p -r1.18 utils.texi
--- utils.texi  25 Oct 2004 15:06:23 -0000      1.18
+++ utils.texi  9 Apr 2005 19:51:39 -0000
@@ -514,7 +514,7 @@ Clear the internal board.
 @item @code{void dump_stack(void)}
 @findex dump_stack
 @quotation
-for use under gdb prints the move stack.
+for use under GDB prints the move stack.
 @end quotation
 @item @code{void add_stone(int pos, int color)}
 @findex add_stone





reply via email to

[Prev in Thread] Current Thread [Next in Thread]