From fb02e4c4d6bb21e687007fe2e7c9960b3cfef640 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Wed, 13 Oct 1999 17:30:50 +0000 Subject: First commit of miscellaneous tools and documentation for a procedure that can be used to produce an online bookshelf of the GNU tools. --- doc/gnu_docs/Tool_Doc_Instructions | 32 +++++++++ doc/gnu_docs/gen_docs | 125 ++++++++++++++++++++++++++++++++++++ doc/gnu_docs/gnu_footer.html | 2 + doc/gnu_docs/gnu_header.html | 5 ++ doc/gnu_docs/index.html | 122 +++++++++++++++++++++++++++++++++++ doc/gnu_docs/mk_install_dir | 29 +++++++++ doc/gnu_docs/refcard.html | 13 ++++ doc/gnu_docs/rtems_tools_index.html | 15 +++++ 8 files changed, 343 insertions(+) create mode 100644 doc/gnu_docs/Tool_Doc_Instructions create mode 100644 doc/gnu_docs/gen_docs create mode 100644 doc/gnu_docs/gnu_footer.html create mode 100644 doc/gnu_docs/gnu_header.html create mode 100644 doc/gnu_docs/index.html create mode 100644 doc/gnu_docs/mk_install_dir create mode 100644 doc/gnu_docs/refcard.html create mode 100644 doc/gnu_docs/rtems_tools_index.html (limited to 'doc/gnu_docs') diff --git a/doc/gnu_docs/Tool_Doc_Instructions b/doc/gnu_docs/Tool_Doc_Instructions new file mode 100644 index 0000000000..37f861d523 --- /dev/null +++ b/doc/gnu_docs/Tool_Doc_Instructions @@ -0,0 +1,32 @@ +# +# $Id$ +# + +Apparently, the tool documentation is tough to build without configuring +in the tool source directory. So you need to do some magic to make +this happen. In addition, the makefiles only support building dvi +and info. + +mkdir doc_build +cp -r binutils-XXX gcc-XXX gdb-XXX newlib-XXX doc_build + +# for each tool +cd binutils-XXX +./configure --target=i386-rtems --prefix=/usr3/tmp/DOCTMP +make info dvi + +# for newlib we have to do the build differently +mkdir b +cd b +../newlib-1.8.2/./configure --target=i386-rtems --prefix=/usr3/tmp/DOCTMP +make +make info dvi +cd ../newlib-1.8.2 +find newlib/ -name "*.t*" | cpio -pdum ../b/i386-rtems/ +find etc/ -name "*.t*" | cpio -pdum ../b + + +NOTE: The actual target is not relevant since the documentation is +always the same. + + diff --git a/doc/gnu_docs/gen_docs b/doc/gnu_docs/gen_docs new file mode 100644 index 0000000000..1e9ba9eb83 --- /dev/null +++ b/doc/gnu_docs/gen_docs @@ -0,0 +1,125 @@ +#! /bin/sh +# +# This script is intended to be run in the build directory of a software +# package including documentation in texinfo format. The basic operation +# of this script is to: +# + find all ".dvi" files from the current directory down, +# + for each dvi file +# + install the dvi file +# + generate PostScript files for the dvi file +# + install the PostScript file +# + if there is texinfo source for this dvi file +# install the info files +# generate PDF from the texinfo source +# install the PDF file +# generate HTML from the texinfo source +# install the HTML file +# +# + +texi2www=/usr1/rtems/rtemsdoc-work/tools/texi2www/texi2www +install=/usr3/rtems_cds/test_cd/doc/tools/html + +#if [ $? -ne 1 ] ; then +# echo "Usage: $0 install_directory" +# exit 1 +#fi + +if [ ! -d ${install} ] ; then + echo "${install} is not a directory" + exit 1 +fi + +#ECHO=echo + +STARTDIR=`pwd` +find . -name "*.dvi" | while read file +do + cd $STARTDIR + cd `dirname $file` + echo $file + i=`basename $file` +#### + b=`echo $i | cut -d'.' -f1` + echo $b + + if [ -d ${install}/${b} ] ; then + echo "Cleaning install point for ${b}" + ${ECHO} rm -rf ${install}/${b} + fi + ${ECHO} mkdir ${install}/${b} + + echo "Copying DVI for ${b}" + ${ECHO} cp ${b}.dvi ${install}/${b} + + echo "Generating PS for ${b}" + ${ECHO} dvips -o ${install}/${b}/${b}.ps ${b}.dvi + + # unfortunately the .dvi names are not always the same. :( + case ${b} in + history) tsrc=hist ;; + readline) tsrc=rlman ;; + *) tsrc=${b} ;; + esac + + case ${b} in + refcard) + cp $d/gnu_docs/refcard.html ${install}/${b} + ;; + *) + if [ -r ${tsrc}.texi ] ; then + ext=texi + elif [ -r ${tsrc}.texinfo ] ; then + ext=texinfo + else + echo "*** + echo "*** Cannot find a texi or texinfo file for ${b}" + echo "*** +exit 1 + fi + + echo "Copying INFO for ${b}" + ${ECHO} cp ${b}.info* ${install}/../info + + case ${b} in + g77) bad_for_pdf="yes" ;; + *) bad_for_pdf="no" ;; + esac + + case ${b} in + gdb) extraargs_for_pdf="-I ../../readline/doc" ;; + *) extraargs_for_pdf="" ;; + esac + if [ ${bad_for_pdf} = "yes" ] ; then + echo "*** " + echo "*** Skipping PDF for ${b}" + echo "*** " + else + echo "Generating PDF for ${b}" + ${ECHO} texi2pdf ${extraargs_for_pdf} ${tsrc}.${ext} && \ + ${ECHO} cp ${tsrc}.pdf ${install}/${b}/${b}.pdf + fi + + # until texi2www is modified to take a search path + case ${b} in + gdb) + sed -e 's/^ @/@/' <../../readline/doc/rluser.texinfo >rluser.texinfo + cp ../../readline/doc/inc-hist.texi . + ;; + readline) + cp rluser.texinfo rluser.texinfo.tmp + sed -e 's/^ @/@/' <../../readline/doc/rluser.texinfo >rluser.texinfo + rm -f rluser.texinfo.tmp + ;; + *) ;; + esac + echo "Generating HTML for ${b}" + ${ECHO} ${texi2www} \ + -dirfile ../index.html \ + -header $d/gnu_docs/gnu_header.html \ + -footer $d/gnu_docs/gnu_footer.html \ + -icons .. -dir ${install}/${b} \ + ${tsrc}.${ext} + ;; + esac +done diff --git a/doc/gnu_docs/gnu_footer.html b/doc/gnu_docs/gnu_footer.html new file mode 100644 index 0000000000..f67e120101 --- /dev/null +++ b/doc/gnu_docs/gnu_footer.html @@ -0,0 +1,2 @@ +

Packaging copyright © 1988-1998 OAR Corporation
+Context copyright by each document's author. See Free Software Foundation for information. diff --git a/doc/gnu_docs/gnu_header.html b/doc/gnu_docs/gnu_header.html new file mode 100644 index 0000000000..6bd6009147 --- /dev/null +++ b/doc/gnu_docs/gnu_header.html @@ -0,0 +1,5 @@ + + + OAR +

RTEMS Tools On-Line Library

+
diff --git a/doc/gnu_docs/index.html b/doc/gnu_docs/index.html new file mode 100644 index 0000000000..7866ec7947 --- /dev/null +++ b/doc/gnu_docs/index.html @@ -0,0 +1,122 @@ + +RTEMS On-Line Library + + + OAR +

RTEMS Tools On-Line Library

+
+ +
  • GNU Compiler Collection (GCC) 2.95.1 + +
  • + + + + Using and Porting the GNU Compiler Collection (GCC)
    • +
  • + + + + The C Preprocessor
    • +
  • + + + + Guide to GNU Chill
    • +
  • + + + + Using and Porting GNU Fortran
    • +     +
    • + +
  • GNU binutils 990901 + +
  • + + + + + + + GNU Binary Utilities
    • +
  • + + + + GNU Binary File Descriptor(libbfd)
    • +
  • + + + + Using the GNU Assembler
    • +
  • + + + + GNU Preprocessor for Assembly Programs (gasp)
    • +
  • + + + + Using the GNU Linker (ld)
    • +     +
    • + +
  • GNU gdb 4.18 + +
  • + + + + Debugging with GDB
    • +
  • + + + + GDB Internals
    • +
  • + + + + STABS Debugging Format
    • +
  • + + + + GDB Quick Reference Card
    • +     +
    • + +
  • Newlib 1.8.2 + +
  • + + + + libc
    • +
  • + + + + libm
    • +     +
    • + +
  • General GNU Project Documentation + +
  • + + + + + + + GNU Coding Standards
    • +     +
    • + +
    +Copyright © 1988-1998 OAR Corporation + diff --git a/doc/gnu_docs/mk_install_dir b/doc/gnu_docs/mk_install_dir new file mode 100644 index 0000000000..52ef35287b --- /dev/null +++ b/doc/gnu_docs/mk_install_dir @@ -0,0 +1,29 @@ +#! /bin/sh +# +# This script creates the install infrastructure for the GNU tools +# documentation. +# + +install=/usr3/rtems_cds/test_cd/doc/tools + +#if [ $? -ne 1 ] ; then +# echo "Usage: $0 install_directory" +# exit 1 +#fi + +rm -rf ${install} +mkdir ${install} +mkdir ${install}/info +mkdir ${install}/html + +cp rtems_tools_index.html ${install}/../index.html +cp index.html ${install}/html +cp ../BAD.html ${install}/html +cp ../tools/texi2www/*.gif ${install}/html +cp ../common/*arrow.gif ${install}/html +cp ../common/up-arrow.gif ${install}/html +cp ../common/oaronly.jpg ${install}/html +cp ../common/dvi.gif ${install}/html +cp ../common/pdf.gif ${install}/html +cp ../common/pdf1.gif ${install}/html +cp ../common/ps.gif ${install}/html diff --git a/doc/gnu_docs/refcard.html b/doc/gnu_docs/refcard.html new file mode 100644 index 0000000000..0e96d95ac2 --- /dev/null +++ b/doc/gnu_docs/refcard.html @@ -0,0 +1,13 @@ + +GDB Reference Card + + + OAR +

    RTEMS On-Line Library

    +
    + +The GDB Reference card is not written in texinfo file. There is currently +no HTML or PDF version of this file. +
    +Copyright © 1988-1999 OAR Corporation + diff --git a/doc/gnu_docs/rtems_tools_index.html b/doc/gnu_docs/rtems_tools_index.html new file mode 100644 index 0000000000..c1aa8ef46d --- /dev/null +++ b/doc/gnu_docs/rtems_tools_index.html @@ -0,0 +1,15 @@ + +RTEMS and Tools On-Line Library + + + OAR +

    RTEMS 19991011 On-Line Library

    +
    + + +
  • RTEMS Documentation
    • +
  • GNU Documentation
    • +     +
    +Copyright © 1988-1998 OAR Corporation + -- cgit v1.2.3