Changeset 14282

Timestamp:

12/03/12 04:12:54 (8 years ago)

Author:

Mark Evenson

Message:

manual: Updates to manual for ABCL 1.1.

Preface to the second addition. TODO TeX.

Added Appendix for SYSTEM and JSS packages. TODO Need to fix LaTex?.

Location:

branches/1.1.x/doc/manual

Files:

• Makefile (modified) (1 diff)
• abcl.tex (modified) (2 diffs)
• extensions.tex (modified) (2 diffs)
• grovel.lisp (modified) (1 diff)
• jss.tex (added)
• system.tex (added)
• threads.tex (modified) (1 diff)

branches/1.1.x/doc/manual/Makefile

@@ -9 +9 @@
   pdflatex abcl.tex
 
-ABCL  = /Users/evenson/work/abcl-1.1.x/abcl
+#ABCL   = abcl
+ABCL  = ../../abcl
+#ABCL = /Users/evenson/work/abcl-1.1.x/abcl
 
+# XXX TODO 1) use more compact iterated form, 2) pare down to using --noinit
 grovel:
-  $(ABCL) --batch --noinform --load "grovel.lisp" --eval '(progn (grovel-docstrings-as-tex (find-package :java)) (grovel-docstrings-as-tex (find-package :extensions)) (grovel-docstrings-as-tex (find-package :threads)))'
+  $(ABCL) --batch --noinform --load "grovel.lisp" \
+    --eval '(grovel-docstrings-as-tex (find-package :java)' \
+    --eval  '(grovel-docstrings-as-tex (find-package :extensions))' \
+  --eval  '(grovel-docstrings-as-tex (find-package :threads))' \
+  --eval  '(grovel-docstrings-as-tex (find-package :system))' \
+  --eval '(progn (require :abcl-contrib) (require :jss) (grovel-docstrings-as-tex (find-package :jss)))'
 
 clean:

branches/1.1.x/doc/manual/abcl.tex

@@ -19 +19 @@
 \tableofcontents
 
-\chapter{Preface}
 %%Preface to the second edition, abcl-1.1.0.
-\section{Second Edition}
+\section{Preface to the Second Edition}
 ABCL 1.1 now contains (A)MOP.  We hope you enjoy!  --The Mgmt.
 
@@ -1261 +1260 @@
 on January 10, 2012.
 
-In December 2012, we we revised the implementation--adding (A)MOP--with
-the release of abcl-1.1.0 and accumulated changes to this manual.
+In December 2012, we we revised the implementation with
+the release of abcl-1.1.0 by adding (A)MOP.
+
+\chapter{Appendix SYSTEM}
+
+\include{system}
+
+\chapter{Appendix JSS}
+
+\include{jss}
+
 
 \bibliography{abcl}

branches/1.1.x/doc/manual/extensions.tex

@@ -131 +131 @@
 
 \begin{adjustwidth}{5em}{5em}
-not-documented
+No-op setting of write timeout to SECONDS on SOCKET.
 \end{adjustwidth}
 
@@ -871 +871 @@
 
 \begin{adjustwidth}{5em}{5em}
-Time in SECONDS to set local implementation of SO\_CREVTIMEO on SOCKET.
+Time in SECONDS to set local implementation of 'SO\_RCVTIMEO' on SOCKET.
 \end{adjustwidth}
 

branches/1.1.x/doc/manual/grovel.lisp

@@ -1 @@
-
+(in-package :cl-user)
 (defun grovel-docstrings-as-tex (&optional (package (find-package :java)))
   (let ((output-file (format nil "~A.tex" (string-downcase (package-name package)))))

branches/1.1.x/doc/manual/threads.tex

@@ -5 +5 @@
 
 \begin{adjustwidth}{5em}{5em}
-not-documented
+Returns non-NIL if the mailbox can be read from, NIL otherwise.
 \end{adjustwidth}