[gnugo-devel] documentation-patch

[ab]

Recently I tried to rearrange 2 file lists in the documentation a bit (instead 
of alphabetical);
don't know if this makes sense to you, because something like this is always 
subjective; I think
however it would.


the file is overview.texi

--- overview.texi.bak 2003-08-15 01:13:58.000000000 +0200
+++ overview2.texi.new 2004-04-18 00:50:43.000000000 +0200
@@ -393,14 +393,18 @@
In @file{engine/} there are the following files:
@itemize @bullet
address@hidden @file{aftermath.c}
+
address@hidden @file{globals.c}
@quotation
-Contains algorithms which may be called at the end of the game to generate
-moves that will generate moves to settle the position, if necessary playing
-out a position to determine exactly the status of every group on the board,
-which GNU Go can get wrong, particularly if there is a seki. This module is
-the basis for the most accurate scoring algorithm available in GNU Go.
+This contains the principal global variables used by GNU Go.
address@hidden quotation
+
address@hidden @file{liberty.h}
address@hidden
+Header file for the engine. The name ``liberty'' connotes
+freedom (@pxref{Copying}).
@end quotation
+
@item @file{board.c}
@quotation
@findex trymove
@@ -412,28 +416,27 @@
stack. At the same time vital information such as the number of
liberties for each string and their location is updated incrementally.
@end quotation
address@hidden @file{breakin.c}
address@hidden
-Code to detect moves which can break into supposed territory and moves
-to prevent this.
address@hidden quotation
address@hidden @file{cache.c} and @file{cache.h}
+
address@hidden @file{gnugo.h}
@quotation
-As a means of speeding up reading, computed results are cached so that
-they can be quickly reused if the same position is encountered through
-e.g. another move ordering. This is implemented using a hash table.
+This file contains declarations forming the public interface to
+the engine.
@end quotation
address@hidden @file{clock.c} and @file{clock.h}
+
address@hidden @file{fuseki.c}
@quotation
-Clock code, including code allowing GNU Go to automatically
-adjust its level in order to avoid losing on time in tournaments.
+Generates fuseki (opening) moves from a database. Also generates moves
+in empty corners.
@end quotation
address@hidden @file{combination.c}
address@hidden
-When something can (only) be captured through a series of ataris or
-other threats we call this a combination attack. This file contains code
-to find such attacks and moves to prevent them.
+
address@hidden @file{worm.c}
address@hidden
+This file contains @code{make_worms()}, code which is run at the
+beginning of each move cycle, before the code in @file{dragon.c}, to
+determine the attributes of every string. These attributes are things
+like liberties, wether the string can be captured (and how), etc
@end quotation
+
@item @file{dragon.c}
@quotation
This contains @code{make_dragons()}. This function is executed before
@@ -443,77 +446,85 @@
how many liberties each has, whether (in GNU Go's opinion) the dragon
can be captured, if it lives, etc.
@end quotation
address@hidden @file{endgame.c}
address@hidden
-Code to find certain types of endgame moves.
address@hidden quotation
address@hidden @file{filllib.c}
+
+
address@hidden @file{shapes.c}
@quotation
-Code to force filling of dame (backfilling if necessary)
-at the end of the game.
address@hidden quotation
address@hidden @file{fuseki.c}
address@hidden
-Generates fuseki (opening) moves from a database. Also generates moves
-in empty corners.
+This file contains @code{shapes()}, the module called by @code{genmove()}
+which tries to find moves which match a pattern (@pxref{Patterns}).
@end quotation
address@hidden @file{genmove.c}
+
address@hidden @file{matchpat.c}
@quotation
-This file contains @code{genmove()} and its supporting
-routines, particularly @code{examine_position()}.
+This file contains the pattern matcher @code{matchpat()}, which looks for
+patterns at a particular board location. The actual patterns are in
+the @file{patterns/} directory. The function @code{matchpat()} is
+called by every module which does pattern matching, notably @code{shapes}.
@end quotation
address@hidden @file{globals.c}
+
address@hidden @file{move_reasons.c} and @file{move_reasons.h}
@quotation
-This contains the principal global variables used by GNU Go.
+Code for keeping track of move reasons.
@end quotation
address@hidden @file{gnugo.h}
address@hidden
-This file contains declarations forming the public interface to
-the engine.
+
address@hidden @file{value_moves.c}
address@hidden
+This file contains the code which assigns values to every move
+after all the move reasons are generated. It also tries to generate
+certain kinds of additional move reasons.
@end quotation
address@hidden @file{hash.c} and @file{hash.h}
+
address@hidden @file{genmove.c}
@quotation
-Hashing code implementing Zobrist hashing. (@pxref{Hashing}) The code in
address@hidden provides a way to hash board positions into compact
descriptions
-which can be efficiently compared. The caching code in @file{cache.c}
-makes use of the board hashes when storing and retrieving read results.
+This file contains @code{genmove()} and its supporting
+routines, particularly @code{examine_position()}.
@end quotation
+
+
@item @file{influence.c} and @file{influence.h}.
@quotation
This code determines which regions of the board are under the
influence of either player.
(@pxref{Influence})
@end quotation
address@hidden @file{liberty.h}
address@hidden
-Header file for the engine. The name ``liberty'' connotes
-freedom (@pxref{Copying}).
address@hidden quotation
address@hidden @file{matchpat.c}
address@hidden
-This file contains the pattern matcher @code{matchpat()}, which looks for
-patterns at a particular board location. The actual patterns are in
-the @file{patterns/} directory. The function @code{matchpat()} is
-called by every module which does pattern matching, notably @code{shapes}.
+
address@hidden @file{surround.c}
address@hidden
+Code to determine whether a dragon is surrounded and to find moves to
+surround with or break out with.
@end quotation
address@hidden @file{move_reasons.c} and @file{move_reasons.h}
+
address@hidden @file{breakin.c}
@quotation
-Code for keeping track of move reasons.
+Code to detect moves which can break into supposed territory and moves
+to prevent this.
@end quotation
+
+
@item @file{movelist.c}
@quotation
Supporting code for lists of moves.
@end quotation
+
address@hidden @file{reading.c}
address@hidden
+This file contains code to determine whether any given
+string can be attacked or defended. @xref{Tactical Reading},
+for details.
address@hidden quotation
+
address@hidden @file{readconnect.c} and @file{readconnect.h}
address@hidden
+This file contains code to determine whether two strings can be
+connected or disconnected.
address@hidden quotation
+
@item @file{optics.c}
@quotation
This file contains the code to recognize eye shapes,
documented in @xref{Eyes}.
@end quotation
address@hidden @file{oracle.c}
address@hidden
-Code to fork off a second GNU Go process which can be used to simulate
-reading with top level information (e.g. dragon partitioning) available.
address@hidden quotation
+
@item @file{owl.c}
@quotation
This file does life and death reading. Move generation is pattern based
@@ -522,47 +533,81 @@
escaping. Semeai reading along the same principles is also implemented
in this file.
@end quotation
address@hidden @file{persistent.c}
+
address@hidden @file{semeai.c}
address@hidden
+This file contains @code{semeai()}, the module which detects dragons
+in semeai. To determine the semeai results the semeai reading in
address@hidden is used.
address@hidden quotation
+
address@hidden @file{combination.c}
@quotation
-Persistent cache which allows reuse of read results at a later move or
-with additional stones outside an active area, which are those
-intersections thought to affect the read result.
+When something can (only) be captured through a series of ataris or
+other threats we call this a combination attack. This file contains code
+to find such attacks and moves to prevent them.
@end quotation
address@hidden @file{printutils.c}
+
address@hidden @file{cache.c} and @file{cache.h}
@quotation
-Print utilities.
+As a means of speeding up reading, computed results are cached so that
+they can be quickly reused if the same position is encountered through
+e.g. another move ordering. This is implemented using a hash table.
@end quotation
address@hidden @file{readconnect.c} and @file{readconnect.h}
+
address@hidden @file{hash.c} and @file{hash.h}
address@hidden
+Hashing code implementing Zobrist hashing. (@pxref{Hashing}) The code in
address@hidden provides a way to hash board positions into compact
descriptions
+which can be efficiently compared. The caching code in @file{cache.c}
+makes use of the board hashes when storing and retrieving read results.
address@hidden quotation
+
address@hidden @file{sgfdecide.c}
@quotation
-This file contains code to determine whether two strings can be
-connected or disconnected.
+Code to generate sgf traces for various types of reading.
@end quotation
address@hidden @file{reading.c}
+
+
address@hidden @file{endgame.c}
address@hidden
+Code to find certain types of endgame moves.
address@hidden quotation
+
address@hidden @file{aftermath.c}
address@hidden
+Contains algorithms which may be called at the end of the game to generate
+moves that will generate moves to settle the position, if necessary playing
+out a position to determine exactly the status of every group on the board,
+which GNU Go can get wrong, particularly if there is a seki. This module is
+the basis for the most accurate scoring algorithm available in GNU Go.
address@hidden quotation
+
address@hidden @file{filllib.c}
@quotation
-This file contains code to determine whether any given
-string can be attacked or defended. @xref{Tactical Reading},
-for details.
+Code to force filling of dame (backfilling if necessary)
+at the end of the game.
@end quotation
+
@item @file{score.c}
@quotation
Implements the Bouzy algorithms (@pxref{Alternative Moyo}) and contains
code for scoring the game.
@end quotation
address@hidden @file{semeai.c}
address@hidden
-This file contains @code{semeai()}, the module which detects dragons
-in semeai. To determine the semeai results the semeai reading in
address@hidden is used.
address@hidden quotation
address@hidden @file{sgfdecide.c}
address@hidden
-Code to generate sgf traces for various types of reading.
+
address@hidden @file{persistent.c}
address@hidden
+Persistent cache which allows reuse of read results at a later move or
+with additional stones outside an active area, which are those
+intersections thought to affect the read result.
@end quotation
address@hidden @file{shapes.c}
address@hidden
-This file contains @code{shapes()}, the module called by @code{genmove()}
-which tries to find moves which match a pattern (@pxref{Patterns}).
+
+
address@hidden @file{utils.c}
address@hidden
+An assortment of utilities, described in greater detail below.
@end quotation
+
@item @file{showbord.c}
@quotation
This file contains @code{showboard()}, which draws an ASCII
@@ -571,28 +616,24 @@
primary interface in GNU Go 1.2, but is now a debugging
aid.
@end quotation
address@hidden @file{surround.c}
address@hidden
-Code to determine whether a dragon is surrounded and to find moves to
-surround with or break out with.
address@hidden quotation
address@hidden @file{utils.c}
+
address@hidden @file{printutils.c}
@quotation
-An assortment of utilities, described in greater detail below.
+Print utilities.
@end quotation
address@hidden @file{value_moves.c}
+
address@hidden @file{oracle.c}
@quotation
-This file contains the code which assigns values to every move
-after all the move reasons are generated. It also tries to generate
-certain kinds of additional move reasons.
+Code to fork off a second GNU Go process which can be used to simulate
+reading with top level information (e.g. dragon partitioning) available.
@end quotation
address@hidden @file{worm.c}
address@hidden
-This file contains @code{make_worms()}, code which is run at the
-beginning of each move cycle, before the code in @file{dragon.c}, to
-determine the attributes of every string. These attributes are things
-like liberties, wether the string can be captured (and how), etc
+
address@hidden @file{clock.c} and @file{clock.h}
address@hidden
+Clock code, including code allowing GNU Go to automatically
+adjust its level in order to avoid losing on time in tournaments.
@end quotation
+
@end itemize
@subsection Files in @file{patterns/}
@@ -623,40 +664,46 @@
@itemize @bullet
address@hidden @file{conn.db}
address@hidden @file{patterns.c}
@quotation
-Database of connection patterns.
+Pattern data, compiled from patterns.db by mkpat.
@end quotation
address@hidden @file{conn.c}
address@hidden @file{patterns.h}
@quotation
-Automatically generated file, containing connection
-patterns in form of struct arrays, compiled by @command{mkpat}
-from @file{conn.db}.
+Header file relating to the pattern databases.
@end quotation
address@hidden @file{eyes.c}
address@hidden @file{patterns.db} and @file{patterns2.db}
@quotation
-Automatically generated file, containing eyeshape
-patterns in form of struct arrays, compiled by @command{mkpat}
-from @file{eyes.db}.
+These contain pattern databases in human readable form.
@end quotation
address@hidden @file{eyes.h}
address@hidden @file{joseki.c}
@quotation
-Header file for @file{eyes.c}.
+Joseki compiler, which takes a joseki file in
+Smart Go Format, and produces a pattern database.
@end quotation
address@hidden @file{eyes.db}
address@hidden @file{sansan.sgf}
@quotation
-Database of eyeshape patterns. @xref{Eyes}, for
-details.
+Smart Go Format file containing 3-3 point openings
@end quotation
address@hidden @file{helpers.c}
address@hidden @file{sansan.db}
@quotation
-These are helper functions to assist in evaluating
-moves by matchpat.
+Pattern database compiled from @file{sansan.sgf}
address@hidden quotation
+
address@hidden @file{komoku.sgf}
address@hidden
+Smart Go Format file containing 3-4 point openings
address@hidden quotation
+
address@hidden @file{komoku.db}
address@hidden
+Automatically generated database of 3-4 point opening
+patterns, make by compiling @file{komoku.sgf}
@end quotation
@item @file{hoshi.sgf}
@@ -670,28 +717,24 @@
patterns, make by compiling @file{hoshi.sgf}
@end quotation
address@hidden @file{joseki.c}
address@hidden @file{mokuhazushi.sgf}
@quotation
-Joseki compiler, which takes a joseki file in
-Smart Go Format, and produces a pattern database.
+Smart Go Format file containing 5-3 point openings
@end quotation
address@hidden @file{komoku.sgf}
address@hidden
-Smart Go Format file containing 3-4 point openings
address@hidden @file{mokuhazushi.db}
address@hidden
+Pattern database compiled from mokuhadzushi.sgf
@end quotation
address@hidden @file{komoku.db}
address@hidden @file{takamoku.sgf}
@quotation
-Automatically generated database of 3-4 point opening
-patterns, make by compiling @file{komoku.sgf}
+Smart Go Format file containing 5-4 point openings
@end quotation
address@hidden @file{mkeyes.c}
address@hidden @file{takamoku.db}
@quotation
-Pattern compiler for the eyeshape databases. This
-program takes @file{eyes.db} as input and produces @file{eyes.c}
-as output.
+Pattern database compiled from takamoku.sgf.
@end quotation
@item @file{mkpat.c}
@@ -703,49 +746,47 @@
@file{patterns.c}, or takes @file{conn.db} and produces @file{conn.c}.
@end quotation
address@hidden @file{mokuhazushi.sgf}
address@hidden
-Smart Go Format file containing 5-3 point openings
address@hidden quotation
-
address@hidden @file{mokuhazushi.db}
address@hidden
-Pattern database compiled from mokuhadzushi.sgf
address@hidden quotation
-
address@hidden @file{sansan.sgf}
address@hidden @file{helpers.c}
@quotation
-Smart Go Format file containing 3-3 point openings
+These are helper functions to assist in evaluating
+moves by matchpat.
@end quotation
address@hidden @file{sansan.db}
address@hidden @file{conn.db}
@quotation
-Pattern database compiled from @file{sansan.sgf}
+Database of connection patterns.
@end quotation
address@hidden @file{takamoku.sgf}
address@hidden @file{conn.c}
@quotation
-Smart Go Format file containing 5-4 point openings
+Automatically generated file, containing connection
+patterns in form of struct arrays, compiled by @command{mkpat}
+from @file{conn.db}.
@end quotation
address@hidden @file{takamoku.db}
address@hidden @file{eyes.c}
@quotation
-Pattern database compiled from takamoku.sgf.
+Automatically generated file, containing eyeshape
+patterns in form of struct arrays, compiled by @command{mkpat}
+from @file{eyes.db}.
@end quotation
address@hidden @file{patterns.c}
address@hidden @file{eyes.h}
@quotation
-Pattern data, compiled from patterns.db by mkpat.
+Header file for @file{eyes.c}.
@end quotation
address@hidden @file{patterns.h}
address@hidden @file{eyes.db}
@quotation
-Header file relating to the pattern databases.
+Database of eyeshape patterns. @xref{Eyes}, for
+details.
@end quotation
address@hidden @file{patterns.db} and @file{patterns2.db}
address@hidden @file{mkeyes.c}
@quotation
-These contain pattern databases in human readable form.
+Pattern compiler for the eyeshape databases. This
+program takes @file{eyes.db} as input and produces @file{eyes.c}
+as output.
@end quotation
@end itemize