[elpa] 01/01: * doc/chess.texi: Document chess-ai-quiescence-depth and chess-ai-best-move. * chess-{ai, crafty, glaurung, gnuchess, sjeng, stockfish}.el: Add custom-manual links to customisation groups.

[Mario Lang]

mlang pushed a commit to branch externals/chess
in repository elpa.

commit d131ff45de4585d3ce86fa28f1f5ea3300506923
Author: Mario Lang <address@hidden>
Date:   Thu Jun 5 19:31:51 2014 +0200

    * doc/chess.texi: Document chess-ai-quiescence-depth and chess-ai-best-move.
    * chess-{ai,crafty,glaurung,gnuchess,sjeng,stockfish}.el: Add custom-manual 
links to customisation groups.
---
 chess-ai.el        |   12 ++++++------
 chess-crafty.el    |    3 ++-
 chess-glaurung.el  |    1 +
 chess-gnuchess.el  |    4 +++-
 chess-sjeng.el     |    1 +
 chess-stockfish.el |    1 +
 chess.info         |   42 ++++++++++++++++++++++++++++--------------
 doc/chess.texi     |   14 ++++++++++++++
 8 files changed, 56 insertions(+), 22 deletions(-)

diff --git a/chess-ai.el b/chess-ai.el
index b0a0bcf..d3a1e5c 100644
--- a/chess-ai.el
+++ b/chess-ai.el
@@ -42,7 +42,8 @@
 
 This module does not allow to configure search time used to calculate
 reply moves.  You can only specify the search depth (see `chess-ai-depth')."
-  :group 'chess)
+  :group 'chess
+  :link '(custom-manual "(chess)AI"))
 
 (defcustom chess-ai-depth 2
   "The default search depth used to prune the search tree.
@@ -312,8 +313,7 @@ DEPTH defaults to the value of `chess-ai-depth'."
       (setq chess-engine-opponent-name "Emacs AI")
       t)
 
-     ((eq event 'new)
-      (chess-engine-set-position nil))
+     ((eq event 'new) (chess-engine-set-position nil))
 
      ((eq event 'move)
       (when (= 1 (chess-game-index game))
@@ -329,11 +329,11 @@ DEPTH defaults to the value of `chess-ai-depth'."
          (funcall chess-engine-response-handler 'move
                   (or (and (bufferp chess-polyglot-book)
                            (buffer-live-p chess-polyglot-book)
-                           (chess-polyglot-book-ply chess-polyglot-book 
position))
+                           (chess-polyglot-book-ply chess-polyglot-book
+                                                    position))
                       (chess-ai-best-move position))))))
 
-     (t
-      (apply 'chess-common-handler game event args)))))
+     (t (apply 'chess-common-handler game event args)))))
 
 (provide 'chess-ai)
 ;;; chess-ai.el ends here
diff --git a/chess-crafty.el b/chess-crafty.el
index ea78090..24265ed 100644
--- a/chess-crafty.el
+++ b/chess-crafty.el
@@ -27,7 +27,8 @@
 
 (defgroup chess-crafty nil
   "The publically available chess engine 'crafty'."
-  :group 'chess-engine)
+  :group 'chess-engine
+  :link '(custom-manual "(chess)Crafty"))
 
 (defcustom chess-crafty-path (or (executable-find "crafty")
                                 (executable-find "wcrafty"))
diff --git a/chess-glaurung.el b/chess-glaurung.el
index 8bee9b6..04e5c3f 100644
--- a/chess-glaurung.el
+++ b/chess-glaurung.el
@@ -25,6 +25,7 @@
 (defgroup chess-glaurung nil
   "The publically available chess engine 'glaurung'."
   :group 'chess-engine
+  :link '(custom-manual "(chess)Glaurung")
   :link '(url-link "http://www.glaurungchess.com/";))
 
 (defcustom chess-glaurung-path (executable-find "glaurung")
diff --git a/chess-gnuchess.el b/chess-gnuchess.el
index 81d7152..248267c 100644
--- a/chess-gnuchess.el
+++ b/chess-gnuchess.el
@@ -26,7 +26,9 @@
 
 (defgroup chess-gnuchess nil
   "The publically available chess engine 'gnuchess'."
-  :group 'chess-engine)
+  :group 'chess-engine
+  :link '(custom-manual "(chess)GNU Chess")
+  :link '(url-link "http://www.gnu.org/software/chess/";))
 
 (defcustom chess-gnuchess-path (let ((exec-path (cons "/usr/games" exec-path)))
                                 (executable-find "gnuchess"))
diff --git a/chess-sjeng.el b/chess-sjeng.el
index 88fec05..a042258 100644
--- a/chess-sjeng.el
+++ b/chess-sjeng.el
@@ -26,6 +26,7 @@
 (defgroup chess-sjeng nil
   "The publically available chess engine 'sjeng'."
   :group 'chess-engine
+  :link '(custom-manual "(chess)Sjeng")
   :link '(url-link "http://sjeng.sourceforge.net";))
 
 (defcustom chess-sjeng-path (executable-find "sjeng")
diff --git a/chess-stockfish.el b/chess-stockfish.el
index 160fc16..9a4480a 100644
--- a/chess-stockfish.el
+++ b/chess-stockfish.el
@@ -25,6 +25,7 @@
 (defgroup chess-stockfish nil
   "The publically available chess engine 'stockfish'."
   :group 'chess-engine
+  :link '(custom-manual "(chess)Stockfish")
   :link '(url-link "http://www.stockfishchess.com";))
 
 (defcustom chess-stockfish-path (executable-find "stockfish")
diff --git a/chess.info b/chess.info
index d9d2cd9..7d480da 100644
--- a/chess.info
+++ b/chess.info
@@ -1341,6 +1341,18 @@ does not require any external programs to be installed.
  -- User Option: chess-ai-depth
      Defines the default search depth for this engine.
 
+ -- User Option: chess-ai-quiescence-depth
+     Defines the number of plies to search for a quiet position.  This
+     is in addition to 'chess-ai-depth'.
+
+   If you'd like to employ the search and evaluation functions provided
+by this module programmatically, the following function is the top-level
+entry point.
+
+ -- Function: chess-ai-best-move position &optional depth eval-fn
+     Find the supposedly best move (ply) for POSITION.  DEPTH defaults
+     to the value of 'chess-ai-depth'.
+
 
 File: chess.info,  Node: Crafty,  Next: Fruit,  Prev: AI,  Up: Engines
 
@@ -1587,7 +1599,9 @@ Function and Variable Index
 [index]
 * Menu:
 
+* chess-ai-best-move:                    AI.                   (line 24)
 * chess-ai-depth:                        AI.                   (line 13)
+* chess-ai-quiescence-depth:             AI.                   (line 16)
 * chess-algebraic-regexp:                Algebraic notation.   (line 33)
 * chess-algebraic-to-ply:                Algebraic notation.   (line 17)
 * chess-coord-to-index:                  Position coordinates. (line 22)
@@ -1838,19 +1852,19 @@ Node: Graphical displays47463
 Node: Engines47617
 Node: Common functions48142
 Node: AI49178
-Node: Crafty49653
-Node: Fruit50384
-Node: Glaurung51230
-Node: GNU Chess51820
-Node: Phalanx52656
-Node: Sjeng53238
-Node: Stockfish53927
-Node: Internet Chess Servers54692
-Node: Connecting to a server55779
-Node: Seeking an opponent for a new game56455
-Node: The sought game display56907
-Node: Concept Index57885
-Node: Function and Variable Index58128
-Node: Key Index70817
+Node: Crafty50145
+Node: Fruit50876
+Node: Glaurung51722
+Node: GNU Chess52312
+Node: Phalanx53148
+Node: Sjeng53730
+Node: Stockfish54419
+Node: Internet Chess Servers55184
+Node: Connecting to a server56271
+Node: Seeking an opponent for a new game56947
+Node: The sought game display57399
+Node: Concept Index58377
+Node: Function and Variable Index58620
+Node: Key Index71455
 
 End Tag Table
diff --git a/doc/chess.texi b/doc/chess.texi
index 4e1948d..5b15a9c 100644
--- a/doc/chess.texi
+++ b/doc/chess.texi
@@ -1587,6 +1587,20 @@ use @kbd{C-u M-x chess @key{RET} ai @key{RET}}.
 Defines the default search depth for this engine.
 @end defopt
 
address@hidden chess-ai-quiescence-depth
+Defines the number of plies to search for a quiet position.
+This is in addition to `chess-ai-depth'.
address@hidden defopt
+
+If you'd like to employ the search and evaluation functions provided
+by this module programmatically, the following function is the top-level
+entry point.
+
address@hidden chess-ai-best-move position &optional depth eval-fn
+Find the supposedly best move (ply) for @var{position}.
address@hidden defaults to the value of `chess-ai-depth'.
address@hidden defun
+
 @node Crafty, Fruit, AI, Engines
 @section Crafty