Re: [gnugo-devel] doc patch

[Arend Bayer]

Gunnar wrote:
> Arend wrote:
> > A couple of comments on the current docs, sorted to be increasingly
> > polemic :-)
> > - incremental.texi should be part of board.texi
>
> Sounds reasonable.

Done
>
> > - The technical chapters on API, handling SGF trees, and the board
> >   library should be moved more to the end.
>
> Agreed.

Done in the patch below. Does the partition into "User's manual",
"An introduction to the GNU Go engine" and "Infrastructure and
Interfaces" as below make sense?

Arend


Index: doc/gnugo.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/gnugo.texi,v
retrieving revision 1.14
diff -u -p -r1.14 gnugo.texi
--- doc/gnugo.texi      6 Jul 2003 17:12:45 -0000       1.14
+++ doc/gnugo.texi      6 Jul 2003 17:26:43 -0000
@@ -75,28 +75,29 @@ are respected.
 @end ifinfo

 @menu
+User's manual
 * Introduction::                What is GNU Go ?
 * Installation::                Installing GNU Go
 * User Guide::                  Using GNU Go

-Programmer's Introduction
+An introduction to the GNU Go engine
 * Overview::                    Overview of the GNU Go engine
 * Analyzing::                   Analyzing GNU Go's moves
-* API::                         API to the GNU Go engine
-* SGF::                         Handling SGF trees in memory
-* Libboard::                    The basic go board library.
-
-GNU Go Internals
 * Move Generation::             How GNU Go generates moves
 * Worms and Dragons::           Dragons and Worms
 * Eyes::                        Eyes and half eyes
 * Patterns::                    Pattern database
-* DFA::                         The DFA Pattern Matcher
 * Tactical Reading::            Tactical Reading
 * Pattern Based Reading::       Pattern Based Reading: Owl and Combinations
 * Influence::                   Influence Function
 * Moyo::                        Estimation of Moyos : Bouzy's 5/21 algorithm
+
+Infrastructure and Interfaces
+* Libboard::                    The basic go board library.
+* SGF::                         Handling SGF trees in memory
+* DFA::                         The DFA Pattern Matcher
 * Utility Functions::           @file{utils.c} and @file{printutils.c}
+* API::                         API to the GNU Go engine
 * GTP::                         The Go Text Protocol
 * Regression::                  Regression testing

@@ -134,20 +135,6 @@ Indices

 @include analyze.texi

address@hidden API
address@hidden Application Programmers Interface to GNU Go
-
address@hidden api.texi
-
address@hidden SGF
address@hidden Handling SGF trees in memory
-
address@hidden sgf.texi
-
address@hidden Libboard
address@hidden The Board Library
-
address@hidden board.texi

 @node Move Generation
 @chapter Move generation
@@ -193,6 +180,21 @@ Indices
 @chapter Moyo

 @include moyo.texi
+
address@hidden Libboard
address@hidden The Board Library
+
address@hidden board.texi
+
address@hidden SGF
address@hidden Handling SGF trees in memory
+
address@hidden sgf.texi
+
address@hidden API
address@hidden Application Programmers Interface to GNU Go
+
address@hidden api.texi

 @node Utility Functions
 @chapter Utility Functions