3 # Create Texinfo snippets from the documentation of exported symbols.
5 # This software is part of the SBCL system. See the README file for
8 # This software is in the public domain and is provided with
9 # absolutely no warranty. See the COPYING and CREDITS files for
14 # We create the documentation from the in-tree sbcl if it is found,
15 # else an installed sbcl is used.
19 sbclsystem=`pwd`/../../src/runtime/sbcl
20 sbclcore=`pwd`/../../output/sbcl.core
21 if [ -e $sbclsystem ] && [ -e $sbclcore ]
23 SBCLRUNTIME="$sbclsystem --core $sbclcore"
24 SBCL_HOME=`pwd`/../../contrib; export SBCL_HOME
26 SBCLRUNTIME="`which sbcl`"
32 SBCL="$SBCLRUNTIME --noinform --sysinit /dev/null --userinit /dev/null --noprint --disable-debugger"
34 # extract version and date
35 VERSION=`$SBCL --eval '(write-line (lisp-implementation-version))' --eval '(sb-ext:quit)'`
38 sed -e "s/@VERSION@/$VERSION/" \
39 -e "s/@MONTH@/$MONTH/" < variables.template > variables.texinfo || exit 1
41 # Output directory. This has to end with a slash (it's interpreted by
42 # Lisp's `pathname' function) or you lose. This is normally set from
44 DOCSTRINGDIR="${DOCSTRINGDIR:-docstrings/}"
46 # List of contrib modules that docstring docs will be created for.
47 # This is normally set from Makefile.
48 #MODULES="${MODULES:-sb-md5 :sb-rotate-byte}"
50 # List of package names that documentation will be created for. This
51 # is normally set from Makefile.
52 #PACKAGES="${PACKAGES:-:COMMON-LISP :SB-ALIEN :SB-DEBUG :SB-EXT :SB-GRAY :SB-MOP :SB-PROFILE :SB-THREAD}"
54 echo /creating docstring snippets from SBCL=\'$SBCLRUNTIME\' for packages \'$PACKAGES\'
56 (load "docstrings.lisp")
57 (dolist (module (quote ($MODULES)))
59 (sb-texinfo:generate-includes "$DOCSTRINGDIR" $PACKAGES)
63 echo /creating package-locks.texi-temp
64 if $SBCL --eval "(let ((plp (find-symbol \"PACKAGE-LOCKED-P\" :sb-ext))) (quit :unix-status (if (and plp (fboundp plp)) 0 1)))";
66 cp package-locks-extended.texinfo package-locks.texi-temp
68 cp package-locks-basic.texinfo package-locks.texi-temp