doc/manual/make-tempfiles.sh

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