From 4684c7c024eeb3a178461f04a2e96d41baa55aae Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Tue, 9 May 2000 17:54:26 +0000 Subject: Updated in order to generate a current tool chain documentation set. --- doc/gnu_docs/Tool_Doc_Instructions | 26 ++++--- doc/gnu_docs/gen_docs | 65 +++++++++++++---- doc/gnu_docs/gnu_header.html | 4 +- doc/gnu_docs/index.html | 136 ++++++++++++++++++------------------ doc/gnu_docs/rtems_tools_index.html | 10 +-- 5 files changed, 144 insertions(+), 97 deletions(-) (limited to 'doc/gnu_docs') diff --git a/doc/gnu_docs/Tool_Doc_Instructions b/doc/gnu_docs/Tool_Doc_Instructions index 37f861d523..85ac79d8fc 100644 --- a/doc/gnu_docs/Tool_Doc_Instructions +++ b/doc/gnu_docs/Tool_Doc_Instructions @@ -4,21 +4,31 @@ 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. +this happen. In addition, the makefiles included with the tools +only support building dvi and info. So this directory is +trying to help finish out building the tool documentation. +# Odd Notes: +# +# binutils/ld: May have to copy bfdsumm.texi from config/bfd to ld +# gcc: no rule to build java.dvi + +# for binutils, gcc, and gdb mkdir doc_build cp -r binutils-XXX gcc-XXX gdb-XXX newlib-XXX doc_build - -# for each tool -cd binutils-XXX +cd TOOL-XXX ./configure --target=i386-rtems --prefix=/usr3/tmp/DOCTMP make info dvi -# for newlib we have to do the build differently +# for newlib we have to do the build differently. It actually needs +# to be configured and built for an RTEMS target so pick something +# you have tools installed for. Hopefully, this will be a target +# without many multilib variants. The actual target is not relevant +# since the documentation is always the same. + mkdir b cd b -../newlib-1.8.2/./configure --target=i386-rtems --prefix=/usr3/tmp/DOCTMP +../newlib-1.8.2/configure --target=i386-rtems --prefix=/usr3/tmp/DOCTMP make make info dvi cd ../newlib-1.8.2 @@ -26,7 +36,5 @@ 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 index 1e9ba9eb83..ecfc4157b6 100644 --- a/doc/gnu_docs/gen_docs +++ b/doc/gnu_docs/gen_docs @@ -17,8 +17,16 @@ # # -texi2www=/usr1/rtems/rtemsdoc-work/tools/texi2www/texi2www -install=/usr3/rtems_cds/test_cd/doc/tools/html +# Ralf... where do these come from using autoconf? +srcdir=/usr1/rtems/work/rtems-doc/ +texi2www=${srcdir}/tools/texi2www/texi2www +gnu_docs=${srcdir}/gnu_docs +images=${srcdir}/images + +install_base=/home/httpd/html/rtems/rtemsdoc-4.5-beta3 +install_share=/home/httpd/html/rtems/rtemsdoc-4.5-beta3/share/toolsdoc +install_info=/home/httpd/html/rtems/rtemsdoc-4.5-beta3/info + #if [ $? -ne 1 ] ; then # echo "Usage: $0 install_directory" @@ -45,15 +53,24 @@ do if [ -d ${install}/${b} ] ; then echo "Cleaning install point for ${b}" - ${ECHO} rm -rf ${install}/${b} + ${ECHO} rm -rf ${install}/html/${b} fi - ${ECHO} mkdir ${install}/${b} + + for dir_to_do in ${install_info} \ + ${install_share}/ps \ + ${install_share}/pdf ${install_share}/dvi \ + ${install_share}/html/${b} + do + test -d ${dir_to_do} || mkdir -p ${dir_to_do} + done echo "Copying DVI for ${b}" - ${ECHO} cp ${b}.dvi ${install}/${b} + echo "+ cp ${b}.dvi ${install_share}/dvi/${b}.dvi" + ${ECHO} cp ${b}.dvi ${install_share}/dvi/${b}.dvi echo "Generating PS for ${b}" - ${ECHO} dvips -o ${install}/${b}/${b}.ps ${b}.dvi + echo "+ dvips -o ${install_share}/ps/${b}.ps ${b}.dvi" + ${ECHO} dvips -o ${install_share}/ps/${b}.ps ${b}.dvi # unfortunately the .dvi names are not always the same. :( case ${b} in @@ -64,9 +81,12 @@ do case ${b} in refcard) - cp $d/gnu_docs/refcard.html ${install}/${b} + cp ${gnu_docs}/refcard.html ${install_share}/${b} ;; *) + # for some reason chill installs the dvi 1 directory up. + test ${b} = "chill" && cd ch + if [ -r ${tsrc}.texi ] ; then ext=texi elif [ -r ${tsrc}.texinfo ] ; then @@ -75,11 +95,11 @@ do echo "*** echo "*** Cannot find a texi or texinfo file for ${b}" echo "*** -exit 1 + exit 1 fi echo "Copying INFO for ${b}" - ${ECHO} cp ${b}.info* ${install}/../info + ${ECHO} cp ${b}.info* ${install_info} case ${b} in g77) bad_for_pdf="yes" ;; @@ -97,7 +117,7 @@ exit 1 else echo "Generating PDF for ${b}" ${ECHO} texi2pdf ${extraargs_for_pdf} ${tsrc}.${ext} && \ - ${ECHO} cp ${tsrc}.pdf ${install}/${b}/${b}.pdf + ${ECHO} cp ${tsrc}.pdf ${install_share}/pdf/${b}.pdf fi # until texi2www is modified to take a search path @@ -116,10 +136,29 @@ exit 1 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} \ + -header ${gnu_docs}/gnu_header.html \ + -footer ${gnu_docs}/gnu_footer.html \ + -icons ../images -dir ${install_share}/html/${b} \ ${tsrc}.${ext} ;; esac done + +echo "Installing graphics" + +test -d ${install_share}/html/images || mkdir ${install_share}/html/images +cd ${images} +for f in dir-arrow.gif dvi.gif missing-arrow.gif next-arrow.gif oaronly.jpg \ + pdf.gif pdf1.gif prev-arrow.gif ps.gif up-arrow.gif +do + cp ${f} ${install_share}/html/images/${f} +done +echo "Installing top level HTML indices" +cp ${gnu_docs}/index.html ${install_share}/html/index.html +cp ${gnu_docs}/rtems_tools_index.html ${install_share}/../index.html + +# Now deal with the reference card +set -x +test -d ${install_share}/html/refcard || mkdir ${install_share}/html/refcard +cp ${gnu_docs}/refcard.html ${install_share}/html/refcard/refcard.html +exit 0 diff --git a/doc/gnu_docs/gnu_header.html b/doc/gnu_docs/gnu_header.html index 6bd6009147..310a73c1c8 100644 --- a/doc/gnu_docs/gnu_header.html +++ b/doc/gnu_docs/gnu_header.html @@ -1,5 +1,5 @@ - OAR -

RTEMS Tools On-Line Library

+ OAR +

RTEMS GNU Tools On-Line Library

diff --git a/doc/gnu_docs/index.html b/doc/gnu_docs/index.html index 03bd3de4b3..985c1e9801 100644 --- a/doc/gnu_docs/index.html +++ b/doc/gnu_docs/index.html @@ -1,60 +1,60 @@ -RTEMS On-Line Library +RTEMS GNU Tools On-Line Library - OAR -

RTEMS Tools On-Line Library

+ OAR +

RTEMS GNU Tools On-Line Library

-
  • GNU Compiler Collection (GCC) 2.95.1 +
  • GNU Compiler Collection (GCC) 2.95.2 -
  • - - +
  • + + Using and Porting the GNU Compiler Collection (GCC)
    • -
  • - - +
  • + + The C Preprocessor
    • -
  • - - +
  • + + Guide to GNU Chill
    • -
  • - - +
  • + + Using and Porting GNU Fortran
    •
    • -
  • GNU binutils 990901 +
  • GNU binutils 2.9.5.0.24 -
  • - - - - - +
  • + + + + + GNU Binary Utilities
    • -
  • - - +
  • + + Using the GNU Assembler
    • -
  • - - +
  • + + GNU Preprocessor for Assembly Programs (gasp)
    • -
  • - - +
  • + + Using the GNU Linker (ld)
    •  @@ -62,24 +62,24 @@
  • GNU gdb 4.18 -
  • - - +
  • + + Debugging with GDB
    • -
  • - - +
  • + + GDB Internals
    • -
  • - - +
  • + + STABS Debugging Format
    • -
  • - - +
  • + + GDB Quick Reference Card
    •  @@ -87,14 +87,14 @@
  • Newlib 1.8.2 -
  • - - +
  • + + libc
    • -
  • - - +
  • + + libm
    •  @@ -102,24 +102,24 @@
  • GNU Libraries Used by Multiple Tools -
  • - - +
  • + + GNU History Library
    • -
  • - - +
  • + + GNU Readline Library
    • -
  • - - +
  • + + GNU Memory-Mapped Malloc Library (mmalloc)
    • -
  • - - +
  • + + GNU Binary File Descriptor (libbfd)
    •  @@ -127,12 +127,12 @@
  • General GNU Project Documentation -
  • - - - - - +
  • + + + + + GNU Coding Standards
    •  diff --git a/doc/gnu_docs/rtems_tools_index.html b/doc/gnu_docs/rtems_tools_index.html index 38f83be513..cfc7367b4a 100644 --- a/doc/gnu_docs/rtems_tools_index.html +++ b/doc/gnu_docs/rtems_tools_index.html @@ -2,14 +2,14 @@ RTEMS and Tools On-Line Library - OAR + OAR

    RTEMS and Tools On-Line Library

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