doc/manual/docstrings.sh

   1 #!/bin/sh
   2
   3 # Create Texinfo snippets from the documentation of exported symbols.
   4
   5 # This software is part of the SBCL system. See the README file for
   6 # more information.
   7 #
   8 # This software is in the public domain and is provided with
   9 # absolutely no warranty. See the COPYING and CREDITS files for
  10 # more information.
  11
  12 # how we invoke SBCL
  13
  14 # We create the documentation from the in-tree sbcl if it is found,
  15 # else an installed sbcl is used.
  16 sbclsystem=`pwd`/../../src/runtime/sbcl
  17 if [ -e $sbclsystem ]
  18 then
  19 SBCL="${1:-$sbclsystem --core `pwd`/../../output/sbcl.core}"
  20 export SBCL_HOME=`pwd`/../../contrib
  21 else
  22 SBCL="${1:-`which sbcl`}"
  23 fi
  24
  25 # Output directory.  This has to end with a slash (it's interpreted by
  26 # Lisp's `pathname' function) or you lose.  This is normally set from
  27 # Makefile.
  28 DOCSTRINGDIR="${DOCSTRINGDIR:-docstrings/}"
  29
  30 # List of package names that documentation will be created for.  This
  31 # is normally set from Makefile.
  32 PACKAGES="${PACKAGES:-:COMMON-LISP :SB-ALIEN :SB-DEBUG :SB-EXT :SB-GRAY :SB-MOP :SB-PROFILE :SB-THREAD}"
  33
  34 echo /creating docstring snippets from SBCL=\'$SBCL\' for packages \'$PACKAGES\'
  35 echo "(progn (load \"docstrings.lisp\") (docstrings-to-texinfo \"$DOCSTRINGDIR\" $PACKAGES) (sb-ext:quit))" | $SBCL --noinform --sysinit /dev/null --userinit /dev/null --noprint --disable-debugger