gnugo-devel
[Top][All Lists]
Advanced

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

[gnugo-devel] Another doc patch


From: Gunnar Farneback
Subject: [gnugo-devel] Another doc patch
Date: Wed, 20 Mar 2002 20:35:13 +0100
User-agent: EMH/1.14.1 SEMI/1.14.3 (Ushinoya) FLIM/1.14.2 (Yagi-Nishiguchi) APEL/10.3 Emacs/20.7 (sparc-sun-solaris2.7) (with unibyte mode)

Further doc revisions.

/Gunnar

Index: doc/api.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/api.texi,v
retrieving revision 1.6
diff -u -r1.6 api.texi
--- doc/api.texi        10 Mar 2002 14:05:07 -0000      1.6
+++ doc/api.texi        20 Mar 2002 19:22:44 -0000
@@ -14,10 +14,7 @@
 SGF file.
 @item GMP - Go Modem Protocol, a protocol for automatic play between two
 computers.
address@hidden GTP - Go Text Protocol, a more general go protocol currently used
-only for testing of the engine. However, GTP is currently being
-standardized and it is expected that GTP will become the main choice for
-tasks where currently GMP is used.
address@hidden GTP - Go Text Protocol, a more general go protocol, @pxref{GTP}.
 @end itemize
 @cindex API
 
@@ -73,7 +70,7 @@
 legal moves. These functions are collected into @code{libengine.a}.
 
 The game handling code helps the application programmer keep tracks
-of the moves in a game, and to undo or redo moves. Games can be saved to
+of the moves in a game. Games can be saved to
 SGF files and then later be read back again. These are also within
 @code{libengine.a}. 
 
@@ -145,7 +142,7 @@
 
 GNU Go uses two different representations of the board, for
 most purposes a one-dimensional one, but for a few purposes a
-two dimensional one (@pxref{The Board}). The one-dimensional
+two dimensional one (@pxref{Libboard}). The one-dimensional
 board was introduced before GNU Go 3.2, while the two-dimensional
 board dates back to the ancestral program written by Man Lung Li
 before 1995. The API still uses the one-dimensional board, so
@@ -338,41 +335,6 @@
 @quotation
 Report the move number.
 @end quotation
address@hidden @code{void gameinfo_clear(Gameinfo *ginfo, int boardsize, float 
komi)}
address@hidden gameinfo_clear
address@hidden
-Initialize the @code{Gameinfo} structure.
address@hidden quotation
address@hidden @code{void gameinfo_print(Gameinfo *ginfo)}
address@hidden gameinfo_print
address@hidden
-Print a gameinfo.
address@hidden quotation
address@hidden @code{void gameinfo_load_sgfheader(Gameinfo *gameinfo, SGFNode 
*head)}
address@hidden gameinfo_load_sgfheader
address@hidden
-Reads header info from sgf structure and sets the appropriate variables.
address@hidden quotation
address@hidden @code{void gameinfo_play_move(Gameinfo *ginfo, int i, int j, int 
color)}
address@hidden gameinfo_play_move
address@hidden
-Make a move in the game. Return 1 if the move was legal. In that
-case the move is actually done. Otherwise return 0.
address@hidden quotation
address@hidden @code{int gameinfo_play_sgftree_rot(Gameinfo *gameinfo, SGFNode 
*head, const char *untilstr, int orientation)}
address@hidden gameinfo_play_sgftree_rot
address@hidden
-Play the moves in an SGF tree. Walk the main variation, actioning the
-properties into the playing board. Returns the color of the next move to be
-made. Head is a sgf tree. Untilstr is an optional string of the form either
-'L12' or '120' which tells it to stop playing at that move or move
-number. When debugging, this is the location of the move being examined.
address@hidden quotation
address@hidden @code{int gameinfo_play_sgftree(Gameinfo *gameinfo, SGFNode 
*head, const char *untilstr)}
address@hidden gameinfo_play_sgftree
address@hidden
-Same as previous function, using standard orientation.
address@hidden quotation
 @end itemize
 
 @section Game handling
@@ -391,31 +353,25 @@
 typedef struct @{
   int       handicap;
 
-  Position  position;
-  int       move_number;
-  int       to_move;           /* whose move it currently is */
-  SGFTree   moves;             /* The moves in the game. */
+  int       to_move;            /* whose move it currently is */
+  SGFTree   game_record;        /* Game record in sgf format. */
 
-  int       seed;              /* random seed */
-  int       computer_player;   /* BLACK, WHITE, or EMPTY (used as BOTH) */
+  int       seed;               /* random seed */
+  int       computer_player;    /* BLACK, WHITE, or EMPTY (used as BOTH) */
 
-  char      outfilename[128];  /* Trickle file */
+  char      outfilename[128];   /* Trickle file */
   FILE      *outfile;
 @} Gameinfo;
 
 @end group
 @end example
 
-The meaning of @code{handicap} should be obvious. The @code{position}
-field is of course the current position, @code{move_number} is the
-number of the current move and @code{to_move} is the color of the side
-whose turn it is to move.
+The meaning of @code{handicap} should be obvious. @code{to_move} is the
+color of the side whose turn it is to move.
 
-The SGF tree @code{moves} is used to store all the moves in the entire
+The SGF tree @code{game_record} is used to store all the moves in the entire
 game, including a header node which contains, among other things, komi
-and handicap. If a player wants to undo a move, this can most easily be
-done by replaying all the moves in the tree except for the last
-one. This is the way it is implemented in @code{gameinfo_undo_move()}.
+and handicap.
 
 If one or both of the opponents is the computer, the fields @code{seed}
 and @code{computer_player} are used. Otherwise they can be
@@ -429,7 +385,7 @@
 GNU Go can use a trickle file to continuously save all the moves of an
 ongoing game. This file can also contain information about internal
 state of the engine such as move reasons for various locations or move
-valuations for the 10 highest valued moves. The name of this file should
+valuations. The name of this file should
 be stored in @code{outfilename} and the file pointer to the open file is
 stored in @code{outfile}. If no trickle file is used,
 @code{outfilename[0]} will contain a null character and @code{outfile}
@@ -445,54 +401,38 @@
 @item @code{void gameinfo_clear(Gameinfo *ginfo, int boardsize, float komi)}
 @findex gameinfo_clear
 @quotation
-Clear the Gameinfo to an empty state. The board size of the
address@hidden is set to @code{boardsize}.
+Initialize the @code{Gameinfo} structure.
 @end quotation
-
 @item @code{void gameinfo_print(Gameinfo *ginfo)}
 @findex gameinfo_print
 @quotation
-Print the Gameinfo on stdout. This is mostly a debug tool.
+Print a gameinfo.
 @end quotation
-
address@hidden @code{void gameinfo_load_sgfheader(Gameinfo *ginfo, SGFNode 
*head)}
address@hidden @code{void gameinfo_load_sgfheader(Gameinfo *gameinfo, SGFNode 
*head)}
 @findex gameinfo_load_sgfheader
 @quotation
-Load header information from the SGF node @code{head} and set the
-appropriate variables in @code{ginfo}.
+Reads header info from sgf structure and sets the appropriate variables.
 @end quotation
-
 @item @code{void gameinfo_play_move(Gameinfo *ginfo, int i, int j, int color)}
 @findex gameinfo_play_move
 @quotation
-Play a move at (@code{i}, @code{j}), record it in @code{moves}, print it
-to the trickle file if any and update @code{move_number} and
address@hidden
+Make a move in the game. Return 1 if the move was legal. In that
+case the move is actually done. Otherwise return 0.
 @end quotation
-
address@hidden @code{void gameinfo_undo_move(Gameinfo *ginfo)}
address@hidden gameinfo_undo_move
address@hidden @code{int gameinfo_play_sgftree_rot(Gameinfo *gameinfo, SGFNode 
*head, const char *untilstr, int orientation)}
address@hidden gameinfo_play_sgftree_rot
 @quotation
-Replays all the moves of the game except the last one. It also updates
address@hidden, @code{to_move} and @code{moves}. If there is a
-trickle file, it is truncated to the second to last move.
-
address@hidden: Not yet implemented.}
+Play the moves in an SGF tree. Walk the main variation, actioning the
+properties into the playing board. Returns the color of the next move to be
+made. Head is an sgf tree. Untilstr is an optional string of the form either
+'L12' or '120' which tells it to stop playing at that move or move
+number. When debugging, this is the location of the move being examined.
 @end quotation
-
address@hidden @code{int gameinfo_play_sgftree(Gameinfo *ginfo, SGFNode *head,
-const char *untilstr)}
address@hidden @code{int gameinfo_play_sgftree(Gameinfo *gameinfo, SGFNode 
*head, const char *untilstr)}
 @findex gameinfo_play_sgftree
 @quotation
-Read header information and play the main variation in the SGF tree
-starting with @code{head}.  Return whose turn it is to move after this
-is done. 
-
-The parameter @code{untilstr} is an optional string of the form 'L12' (a
-board position) or '120' (a move number) which tells the function to
-stop playing at that move or move number.
+Same as previous function, using standard orientation.
 @end quotation
-
 @end itemize
 
 
Index: doc/board.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/board.texi,v
retrieving revision 1.6
diff -u -r1.6 board.texi
--- doc/board.texi      10 Mar 2002 14:05:07 -0000      1.6
+++ doc/board.texi      20 Mar 2002 19:22:44 -0000
@@ -10,7 +10,7 @@
 routines for handling go boards.  This board library, called
 @file{libboard}, can be used for those programs that only need a
 basic go board but no AI capability. One such program is
address@hidden/joseki} subdirectory, which compiles joseki pattern
address@hidden/joseki.c}, which compiles joseki pattern
 databases from SGF files.
 
 The library consists of the following files:
Index: doc/introduction.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/introduction.texi,v
retrieving revision 1.6
diff -u -r1.6 introduction.texi
--- doc/introduction.texi       4 Mar 2002 06:49:08 -0000       1.6
+++ doc/introduction.texi       20 Mar 2002 19:22:49 -0000
@@ -98,7 +98,7 @@
 Wallin, Thomas Traber, Douglas Ridgway, Teun Burgers, Tanguy
 Urvoy, Thien-Thi Nguyen, Heikki Levanto, Mark Vytlacil,
 Adriaan van Kessel, Wolfgang Manner, Jens Yllman, Don Dailey,
-Mans Ullerstam, Arend Bayer and Trevor Morris.
address@hidden Ullerstam, Arend Bayer and Trevor Morris.
 
 @node Thanks, TODO, Authors, Introduction
 @comment node-name,    next,        previous,     up
@@ -110,7 +110,7 @@
 report)!
 
 Thanks to Gary Boos, Peter Gucwa, Martijn van der Kooij, Michael
-Margolis, Trevor Morris, Mans Ullerstam, Don Wagner and Yin Zheng for help
+Margolis, Trevor Morris, address@hidden Ullerstam, Don Wagner and Yin Zheng 
for help
 with Visual C++.
 
 And thanks to Alan Crossman, Stephan Somogyi, Pierce Wetter and Mathias Wagner
Index: doc/move_generation.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/move_generation.texi,v
retrieving revision 1.11
diff -u -r1.11 move_generation.texi
--- doc/move_generation.texi    19 Mar 2002 19:03:59 -0000      1.11
+++ doc/move_generation.texi    20 Mar 2002 19:22:51 -0000
@@ -568,14 +568,14 @@
 @findex add_lunch
 @quotation
 See if a lunch is already in the list of lunches, otherwise add a new
-entry. A lunch is in this context a pair of eater (a dragon) and food
-(a worm).
+entry. A lunch is in this context a pair of @code{eater} (a dragon) and
address@hidden (a worm).
 @end quotation
 @item @code{void remove_lunch(int eater, int food)}
 @findex remove_lunch
 @quotation
 Remove a lunch from the list of lunches.  A lunch is in this context a
-pair of eater (a dragon) and food (a worm).
+pair of @code{eater} (a dragon) and @code{food} (a worm).
 @end quotation
 @item @code{int move_reason_known(int pos, int type, int what)}
 @findex move_reason_known
@@ -604,20 +604,20 @@
 @item @code{void add_attack_move(int pos, int ww, int code)}
 @findex add_attack_move
 @quotation
-Add to the reasons for the move at (pos) that it attacks the worm
-at (ww).
+Add to the reasons for the move at @code{pos} that it attacks the worm
+at @code{ww}.
 @end quotation
 @item @code{void add_defense_move(int pos, int ww, int code)}
 @findex add_defense_move
 @quotation
-Add to the reasons for the move at (pos) that it defends the worm
-at (ww).
+Add to the reasons for the move at @code{pos} that it defends the worm
+at @code{ww}.
 @end quotation
 @item @code{void add_attack_threat_move(int pos, int ww, int code)}
 @findex add_attack_threat_move
 @quotation
-Add to the reasons for the move at (pos) that it threatens to
-attack the worm at (ww).
+Add to the reasons for the move at @code{pos} that it threatens to
+attack the worm at @code{ww}.
 @end quotation
 @item @code{void remove_attack_threat_move(int pos, int ww)}
 @findex remove_attack_threat_move
@@ -627,39 +627,39 @@
 @item @code{void add_defense_threat_move(int pos, int ww, int code)}
 @findex add_defense_threat_move
 @quotation
-Add to the reasons for the move at (pos) that it defends the worm
-at (ww).
+Add to the reasons for the move at @code{pos} that it defends the worm
+at @code{ww}.
 @end quotation
 @item @code{int get_attack_threats(int pos, int max_strings, int strings[])}
 @findex get_attack_threats
 @quotation
 Report all, or up to max_strings, strings that are threatened 
-at (pos).
+at @code{pos}.
 @end quotation
 @item @code{int get_defense_threats(int pos, int max_strings, int strings[])}
 @findex get_defense_threats
 @quotation
 Report all, or up to max_strings, strings that might be defended 
-at (pos).
+at @code{pos}.
 @end quotation
 @item @code{int get_biggest_owl_target(int pos)}
 @findex get_biggest_owl_target
 @quotation
 Report the biggest dragon that is owl-affected (possibily with ko)
-by a move at (pos).
+by a move at @code{pos}.
 @end quotation
 @item @code{void add_connection_move(int pos, int dr1, int dr2)}
 @findex add_connection_move
 @quotation
-Add to the reasons for the move at (pos) that it connects the
-dragons at (dr1) and (dr2). Require that the dragons are
+Add to the reasons for the move at @code{pos} that it connects the
+dragons at @code{dr1} and @code{dr2}. Require that the dragons are
 distinct.
 @end quotation
 @item @code{void add_cut_move(int pos, int dr1, int dr2)}
 @findex add_cut_move
 @quotation
-Add to the reasons for the move at (pos) that it cuts the
-dragons at (dr1) and (dr2). Require that the dragons are
+Add to the reasons for the move at @code{pos} that it cuts the
+dragons at @code{dr1} and @code{dr2}. Require that the dragons are
 distinct.
 @end quotation
 @item @code{void add_antisuji_move(int pos)}
@@ -672,8 +672,8 @@
 @item @code{void add_semeai_move(int pos, int dr)}
 @findex add_semeai_move
 @quotation
-Add to the reasons for the move at (pos) that it wins the
-dragon (friendly or not) at (dr) in semeai. Since it is
+Add to the reasons for the move at @code{pos} that it wins the
+dragon (friendly or not) at @code{dr} in semeai. Since it is
 possible that in some semeai one player can kill but the
 other can only make seki, it is possible that one dragon
 is already alive in seki. Therefore separate move reasons
@@ -682,61 +682,61 @@
 @item @code{void add_semeai_threat(int pos, int dr)}
 @findex add_semeai_threat
 @quotation
-Add to the reasons for the move at (pos) that given two
+Add to the reasons for the move at @code{pos} that given two
 moves in a row a move here can win the dragon (friendly or
-not) at (dr) in semeai. Such a move can be used as a 
+not) at @code{dr} in semeai. Such a move can be used as a 
 ko threat, and it is also given some value due to uncertainty
 in the counting of liberties.
 @end quotation
 @item @code{void add_vital_eye_move(int pos, int eyespace, int color)}
 @findex add_vital_eye_move
 @quotation
-Add to the reasons for the move at (pos) that its the vital
-point for the eye space at (eyespace) of color.
+Add to the reasons for the move at @code{pos} that its the vital
+point for the eye space at @code{eyespace} of @code{color}.
 @end quotation
 @item @code{void add_either_move(int pos, int reason1, int target1, int 
reason2, int target2)}
 @findex add_either_move
 @quotation
-Add to the reasons for the move at (pos) that it will accomplish
-one of two things: either (reason1) on (target1) or (reason2) on 
-(target2). At this time, (reason) can only be ATTACK_STRING.
-More reasons will be implemented in the future.
+Add to the reasons for the move at @code{pos} that it will accomplish
+one of two things: either @code{reason1} on @code{target1} or
address@hidden on @code{target2}. At this time, @code{reason} can only
+be @code{ATTACK_STRING}. More reasons will be implemented in the future.
 @end quotation
 @item @code{void add_all_move(int pos, int reason1, int target1, int reason2, 
int target2)}
 @findex add_all_move
 @quotation
-Add to the reasons for the move at (pos) that it will accomplish
-both of two things: (reason1) on (target1) and (reason2) on 
-(target2). At this time, (reason) can only be DEFEND_STRING.
+Add to the reasons for the move at @code{pos} that it will accomplish
+both of two things: @code{reason1} on @code{target1} and @code{reason2} on 
address@hidden At this time, @code{reason} can only be @code{DEFEND_STRING}.
 More reasons will be implemented in the future.
 @end quotation
 @item @code{void add_block_territory_move(int pos)}
 @findex add_block_territory_move
 @quotation
-Add to the reasons for the move at (pos) that it secures
+Add to the reasons for the move at @code{pos} that it secures
 territory by blocking.
 @end quotation
 @item @code{void add_block_territory_move(int pos)}
 @findex add_block_territory_move
 @quotation
-Add to the reasons for the move at (pos) that it secures
+Add to the reasons for the move at @code{pos} that it secures
 territory by blocking.
 @end quotation
 @item @code{void add_expand_territory_move(int pos)}
 @findex add_expand_territory_move
 @quotation
-Add to the reasons for the move at (pos) that it expands
+Add to the reasons for the move at @code{pos} that it expands
 territory.
 @end quotation
 @item @code{void add_expand_moyo_move(int pos) }
 @findex add_expand_moyo_move
 @quotation
-Add to the reasons for the move at (pos) that it expands moyo.
+Add to the reasons for the move at @code{pos} that it expands moyo.
 @end quotation
 @item @code{void add_shape_value(int pos, float value)}
 @findex add_shape_value
 @quotation
-This function is called when a shape value for the move at (pos)
+This function is called when a shape value for the move at @code{pos}
 is found. We keep track of the largest positive shape value found, and the
 total number of positive contributions, as well as the largest
 negative shape value found, and the total number of negative
@@ -765,33 +765,33 @@
 @item @code{void add_strategical_attack_move(int pos, int dr)}
 @findex add_strategical_attack_move
 @quotation
-Add to the reasons for the move at (pos) that it attacks
-the dragon (dr) on a strategical level.
+Add to the reasons for the move at @code{pos} that it attacks
+the dragon @code{dr} on a strategical level.
 @end quotation
 @item @code{void add_strategical_defense_move(int pos, int dr)}
 @findex add_strategical_defense_move
 @quotation
-Add to the reasons for the move at (pos) that it defends
-the dragon (dr) on a strategical level.
+Add to the reasons for the move at @code{pos} that it defends
+the dragon @code{dr} on a strategical level.
 @end quotation
 @item @code{void add_owl_attack_move(int pos, int dr, int code)}
 @findex add_owl_attack_move
 @quotation
-Add to the reasons for the move at (pos) that the owl
-code reports an attack on the dragon (dr).
+Add to the reasons for the move at @code{pos} that the owl
+code reports an attack on the dragon @code{dr}.
 @end quotation
 @item @code{void add_owl_defense_move(int pos, int dr, int code)}
 @findex add_owl_defense_move
 @quotation
-Add to the reasons for the move at (pos) that the owl
-code reports a defense of the dragon (dr).
+Add to the reasons for the move at @code{pos} that the owl
+code reports a defense of the dragon @code{dr}.
 @end quotation
 @item @code{void add_owl_attack_threat_move(int pos, int dr, int code)}
 @findex add_owl_attack_threat_move
 @quotation
-Add to the reasons for the move at (pos) that the owl
-code reports a move threatening to attack the dragon enemy (dr).
-That is, if the attacker is given two moves in a row, (pos)
+Add to the reasons for the move at @code{pos} that the owl
+code reports a move threatening to attack the dragon enemy @code{dr}.
+That is, if the attacker is given two moves in a row, @code{pos}
 can be the first move.
 @end quotation
 @item @code{void add_owl_uncertain_defense_move(int pos, int dr)}
@@ -811,15 +811,15 @@
 @item @code{void add_owl_defense_threat_move(int pos, int dr, int code)}
 @findex add_owl_defense_threat_move
 @quotation
-Add to the reasons for the move at (pos) that the owl
-code reports a move threatening to rescue the dragon (dr).
-That is, if the defender is given two moves in a row, (pos)
+Add to the reasons for the move at @code{pos} that the owl
+code reports a move threatening to rescue the dragon @code{dr}.
+That is, if the defender is given two moves in a row, @code{pos}
 can be the first move.
 @end quotation
 @item @code{void add_my_atari_atari_move(int pos, int size)}
 @findex add_my_atari_atari_move
 @quotation
-Add to the reasons for the move at (pos) that it captures
+Add to the reasons for the move at @code{pos} that it captures
 at least one of a set of worms which individually are tactically
 safe (such as a double atari). Only one such move reason is
 permitted per move.
@@ -827,17 +827,17 @@
 @item @code{void add_your_atari_atari_move(int pos, int size)}
 @findex add_your_atari_atari_move
 @quotation
-Add to the reasons for the move at (pos) that it stops a
+Add to the reasons for the move at @code{pos} that it stops a
 combination attack for the opponent.
 @end quotation
 @item @code{void add_owl_prevent_threat_move(int pos, int dr) }
 @findex add_owl_prevent_threat_move
 @quotation
-Add to the reasons for the move at (pos) that the owl code reports a
-move threatening to defend the dragon enemy (dr), and that (pos) is a
+Add to the reasons for the move at @code{pos} that the owl code reports a
+move threatening to defend the dragon enemy @code{dr}, and that @code{pos} is a
 move which attacks the dragon.  That is, if the defender is given two
-moves in a row, (pos) can be the first move. Hopefully playing at
-(pos) makes it harder for the dragon to live.
+moves in a row, @code{pos} can be the first move. Hopefully playing at
address@hidden makes it harder for the dragon to live.
 @end quotation
 @item @code{void add_followup_value(int pos, float value)}
 @findex add_followup_value
@@ -867,23 +867,23 @@
 @item @code{void add_replacement_move(int from, int to)}
 @findex add_replacement_move
 @quotation
-Add a point redistribution rule, sending the points from (from)
-to (to).
+Add a point redistribution rule, sending the points from @code{from}
+to @code{to}.
 @end quotation
 @item @code{void get_saved_worms(int pos, int saved[BOARDMAX])}
 @findex get_saved_worms
 @quotation
-Find worms rescued by a move at (pos).
+Find worms rescued by a move at @code{pos}.
 @end quotation
 @item @code{void get_saved_dragons(int pos, int saved[BOARDMAX])}
 @findex get_saved_dragons
 @quotation
-Find dragons rescued by a move at (pos).
+Find dragons rescued by a move at @code{pos}.
 @end quotation
 @item @code{void list_move_reasons(int color)}
 @findex list_move_reasons
 @quotation
-List the move reasons for (color).
+List the move reasons for @code{color}.
 @end quotation
 @item @code{void discard_redundant_move_reasons(int pos)}
 @findex discard_redundant_move_reasons
@@ -894,19 +894,19 @@
 @item @code{int is_antisuji_move(int pos)}
 @findex is_antisuji_move
 @quotation
-Look through the move reasons to see whether (pos) is an antisuji move.
+Look through the move reasons to see whether @code{pos} is an antisuji move.
 @end quotation
 @item @code{int move_connects_strings(int pos, int color)}
 @findex move_connects_strings
 @quotation
 Count how many distinct strings are (solidly) connected by the move
-at (pos). Add a bonus for strings with few liberties. Also add
+at @code{pos}. Add a bonus for strings with few liberties. Also add
 bonus for opponent strings put in atari or removed.
 @end quotation
 @item @code{int move_reasons_confirm_safety(int move, int color, int minsize)}
 @findex move_reasons_confirm_safety
 @quotation
-Find saved dragons and worms, then call confirm_safety().
+Find saved dragons and worms, then call @code{confirm_safety()}.
 @end quotation
 @end itemize
 
@@ -950,7 +950,7 @@
 @quotation
 It's often bad to run away with a worm that is in a strategically
 weak position. This function gives heuristics for determining
-whether a move at (tt) to defend the worm (aa) is
+whether a move at @code{tt} to defend the worm @code{aa} is
 strategically sound.
 @end quotation
 @item @code{static void induce_secondary_move_reasons(int color)}
@@ -993,11 +993,11 @@
 @item @code{static float connection_value(int dragona, int dragonb, int tt, 
float margin)}
 @findex connection_value
 @quotation
-Strategical value of connecting (or cutting) the dragon at (dragona)
-to the dragon at (dragonb). Notice that this function is assymetric.
-This is because connection_value(a, b) is intended to measure the
+Strategical value of connecting (or cutting) the dragon at @code{dragona}
+to the dragon at @code{dragonb}. Notice that this function is assymetric.
+This is because @code{connection_value(a, b)} is intended to measure the
 strategical value on the a dragon from a connection to the b dragon.
-The parameter 'margin' is the margin by which we are ahead.
+The parameter @code{margin} is the margin by which we are ahead.
 If this exceeds 20 points we use the cautious impact values
 which value connections more.  This is because we can afford
 to waste a move making sure of safety. If the margin is between
@@ -1009,7 +1009,7 @@
 @quotation
 Usually the value of attacking a worm is twice its effective size,
 but when evaluating certain move reasons we need to adjust this to
-take effects on neighbors into account, e.g. for an attack_either
+take effects on neighbors into account, e.g. for an @code{ATTACK_EITHER}
 move reason. This does not apply to the attack and defense move
 reasons, however, because then the neighbors already have separate
 attack or defense move reasons (if such apply).
@@ -1019,29 +1019,29 @@
 should't be accounted for here.  As a guess, we suppose that
 a critical dragon is alive for our purpose here.
 On the other hand if it has an adjacent critical worm, and
-if (pos) does not defend that worm, we subtract the value of the
-worm, since (pos) may be defended by attacking that worm. We make at
+if @code{pos} does not defend that worm, we subtract the value of the
+worm, since @code{pos} may be defended by attacking that worm. We make at
 most one adjustment of each type.
 @end quotation
 @item @code{static void estimate_territorial_value(int pos, int color, float 
score)}
 @findex estimate_territorial_value
 @quotation
-Estimate the direct territorial value of a move at (pos).
+Estimate the direct territorial value of a move at @code{pos}.
 @end quotation
 @item @code{static void estimate_strategical_value(int pos, int color, float 
score)}
 @findex estimate_strategical_value
 @quotation
-Estimate the strategical value of a move at (pos).
+Estimate the strategical value of a move at @code{pos}.
 @end quotation
 @item @code{static int compare_move_reasons(const void *p1, const void *p2)}
 @findex compare_move_reasons
 @quotation
-Compare two move reasons, used for sorting before presentation. */
+Compare two move reasons, used for sorting before presentation.
 @end quotation
 @item @code{static float value_move_reasons(int pos, int color, float 
pure_threat_value, float score)}
 @findex value_move_reasons
 @quotation
-Combine the reasons for a move at (pos) into a simple numerical value.
+Combine the reasons for a move at @code{pos} into a simple numerical value.
 @end quotation
 @item @code{static void value_moves(int color, float pure_threat_value, float 
score)}
 @findex value_moves
Index: doc/using.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/using.texi,v
retrieving revision 1.6
diff -u -r1.6 using.texi
--- doc/using.texi      19 Mar 2002 19:03:59 -0000      1.6
+++ doc/using.texi      20 Mar 2002 19:22:53 -0000
@@ -284,7 +284,7 @@
 @end quotation
 @item @option{--mode @var{mode}} 
 @quotation
-Force the playing mode ('ascii', 'test,' 'gmp' or 'gtp'). The default is
+Force the playing mode ('ascii', 'emacs,' 'gmp' or 'gtp'). The default is
 ASCII, but if no terminal is detected GMP (Go Modem Protocol) will be
 assumed. In practice this is usually what you want, so you may never
 need this option.
@@ -297,17 +297,18 @@
 @quotation
 @cindex cache-size
 @cindex cache
-Memory in megabytes used for hashing. The default size is 16 unless you
-configure gnugo with the command @command{configure
+Memory in megabytes used for caching of read results. The default size
+is 16 unless you configure gnugo with the command @command{configure
 address@hidden before compiling to make @var{size} the
-default (@pxref{Installation}).  GNU Go stores results of its reading
-calculations in a Hash table (@pxref{Hashing}). If the Hash table is filled,
-it is emptied and the reading continues, but some reading may have to be
-repeated that was done earlier, so a larger cache size will make GNU Go run
-faster, provided the cache is not so large that swapping occurs. Swapping may
-be detected on GNU/Linux machines using the program @command{top}. However if
-you have ample memory or if performance seems to be a problem may want to
-increase the size of the Hash cache using this option.
+default (@pxref{Installation}). GNU Go stores results of its reading
+calculations in a Hash table (@pxref{Hashing}). If the Hash table is
+filled, it is emptied and the reading continues, but some reading may
+have to be repeated that was done earlier, so a larger cache size will
+make GNU Go run faster, provided the cache is not so large that swapping
+occurs. Swapping may be detected on GNU/Linux machines using the program
address@hidden However, if you have ample memory or if performance seems
+to be a problem you may want to increase the size of the cache using
+this option.
 @end quotation
 @item @option{--chinese-rules} 
 @quotation
Index: doc/utils.texi
===================================================================
RCS file: /cvsroot/gnugo/gnugo/doc/utils.texi,v
retrieving revision 1.6
diff -u -r1.6 utils.texi
--- doc/utils.texi      19 Mar 2002 19:03:59 -0000      1.6
+++ doc/utils.texi      20 Mar 2002 19:22:53 -0000
@@ -331,12 +331,12 @@
 The indentation referred to in the last item displays the stack depth.
 
 @itemize @bullet
address@hidden @code{int  gprintf(const char *fmt, ...)}
address@hidden @code{int gprintf(const char *fmt, ...)}
 @findex gprintf
 @quotation
 The most common formatted print function, writes to stderr.
 @end quotation
address@hidden @code{void  gfprintf(FILE *outfile, const char *fmt, ...)}
address@hidden @code{void gfprintf(FILE *outfile, const char *fmt, ...)}
 @findex gfprintf
 @quotation
 Wrapper around @code{vgprintf}, writes to outfile.
@@ -348,7 +348,7 @@
 TRACE(const char *fmt, ...)
 Like @code{gprintf}, but silent if the global variable @code{verbose} is
 zero.
address@hidden @code{void  abortgo(const char *file, int line, const char *msg, 
int x, int y)}
address@hidden @code{void abortgo(const char *file, int line, const char *msg, 
int x, int y)}
 @findex abortgo
 @quotation
 A wrapper around @code{abort()} which shows the state variables at the time



reply via email to

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