forked from Imagelibrary/rtems
First commit of miscellaneous tools and documentation for a procedure
that can be used to produce an online bookshelf of the GNU tools.
This commit is contained in:
Joel Sherrill
32
doc/gnu_docs/Tool_Doc_Instructions
Normal file
32
doc/gnu_docs/Tool_Doc_Instructions
Normal file
@@ -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.
|
||||||
|
|
||||||
|
|
||||||
125
doc/gnu_docs/gen_docs
Normal file
125
doc/gnu_docs/gen_docs
Normal file
@@ -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
|
||||||
2
doc/gnu_docs/gnu_footer.html
Normal file
2
doc/gnu_docs/gnu_footer.html
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
<P>Packaging copyright © 1988-1998 <A HREF="http://www.oarcorp.com" target="Text Frame">OAR Corporation</A></BR>
|
||||||
|
Context copyright by each document's author. See <A HREF="http://www.gnu.org" target="Text Frame">Free Software Foundation</A> for information.
|
||||||
5
doc/gnu_docs/gnu_header.html
Normal file
5
doc/gnu_docs/gnu_header.html
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
<BODY BGCOLOR="FFFFFF">
|
||||||
|
<A HREF="http://www.oarcorp.com" target="Text Frame">
|
||||||
|
<IMG align=right BORDER=0 SRC="../oaronly.jpg" ALT="OAR"> </A>
|
||||||
|
<H1>RTEMS Tools On-Line Library</H1>
|
||||||
|
<HR>
|
||||||
122
doc/gnu_docs/index.html
Normal file
122
doc/gnu_docs/index.html
Normal file
@@ -0,0 +1,122 @@
|
|||||||
|
<HTML>
|
||||||
|
<HEAD><TITLE>RTEMS On-Line Library</TITLE></HEAD>
|
||||||
|
<BODY BGCOLOR="FFFFFF">
|
||||||
|
<A HREF="http://www.oarcorp.com" target="Text Frame">
|
||||||
|
<IMG align=right BORDER=0 SRC="oaronly.jpg" ALT="OAR"> </A>
|
||||||
|
<H1>RTEMS Tools On-Line Library</H1>
|
||||||
|
<HR>
|
||||||
|
<BODY>
|
||||||
|
<LI>GNU Compiler Collection (GCC) 2.95.1
|
||||||
|
<MENU>
|
||||||
|
<LI><A HREF="gcc/gcc.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gcc/gcc.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gcc/gcc.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gcc/index.html">
|
||||||
|
Using and Porting the GNU Compiler Collection (GCC)</A></LI>
|
||||||
|
<LI><A HREF="cpp/cpp.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="cpp/cpp.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="cpp/cpp.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="cpp/index.html">
|
||||||
|
The C Preprocessor</A></LI>
|
||||||
|
<LI><A HREF="chill/chill.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="chill/chill.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="chill/chill.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="chill/index.html">
|
||||||
|
Guide to GNU Chill</A></LI>
|
||||||
|
<LI><A HREF="BAD.html"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="g77/g77.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="g77/g77.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="cpp/index.html">
|
||||||
|
Using and Porting GNU Fortran</A></LI>
|
||||||
|
</MENU>
|
||||||
|
</LI>
|
||||||
|
|
||||||
|
<LI>GNU binutils 990901
|
||||||
|
<MENU>
|
||||||
|
<LI><A HREF="binutils/binutils.pdf">
|
||||||
|
<IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="binutils/binutils.ps">
|
||||||
|
<IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="binutils/binutils.dvi">
|
||||||
|
<IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="binutils/index.html">
|
||||||
|
GNU Binary Utilities</A></LI>
|
||||||
|
<LI><A HREF="bfd/bfd.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="bfd/bfd.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="bfd/bfd.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="bfd/index.html">
|
||||||
|
GNU Binary File Descriptor(libbfd)</A></LI>
|
||||||
|
<LI><A HREF="as/as.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="as/as.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="as/as.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="as/index.html">
|
||||||
|
Using the GNU Assembler</A></LI>
|
||||||
|
<LI><A HREF="gasp/gasp.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gasp/gasp.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gasp/gasp.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gasp/index.html">
|
||||||
|
GNU Preprocessor for Assembly Programs (gasp)</A></LI>
|
||||||
|
<LI><A HREF="ld/ld.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="ld/ld.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="ld/ld.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="ld/index.html">
|
||||||
|
Using the GNU Linker (ld)</A></LI>
|
||||||
|
</MENU>
|
||||||
|
</LI>
|
||||||
|
|
||||||
|
<LI>GNU gdb 4.18
|
||||||
|
<MENU>
|
||||||
|
<LI><A HREF="gdb/gdb.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gdb/gdb.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gdb/gdb.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gdb/index.html">
|
||||||
|
Debugging with GDB</A></LI>
|
||||||
|
<LI><A HREF="gdbint/gdbint.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gdbint/gdbint.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gdbint/gdbint.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="gdbint/index.html">
|
||||||
|
GDB Internals</A></LI>
|
||||||
|
<LI><A HREF="stabs/stabs.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="stabs/stabs.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="stabs/stabs.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="stabs/index.html">
|
||||||
|
STABS Debugging Format</A></LI>
|
||||||
|
<LI><A HREF="refcard/refcard.html"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="refcard/refcard.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="refcard/refcard.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="refcard/refcard.html">
|
||||||
|
GDB Quick Reference Card</A></LI>
|
||||||
|
</MENU>
|
||||||
|
</LI>
|
||||||
|
|
||||||
|
<LI>Newlib 1.8.2
|
||||||
|
<MENU>
|
||||||
|
<LI><A HREF="libc/libc.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="libc/libc.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="libc/libc.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="libc/index.html">
|
||||||
|
libc</A></LI>
|
||||||
|
<LI><A HREF="libm/libm.pdf"><IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="libm/libm.ps"><IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="libm/libm.dvi"><IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="libm/index.html">
|
||||||
|
libm</A></LI>
|
||||||
|
</MENU>
|
||||||
|
</LI>
|
||||||
|
|
||||||
|
<LI>General GNU Project Documentation
|
||||||
|
<MENU>
|
||||||
|
<LI><A HREF="standards/standards.pdf">
|
||||||
|
<IMG SRC="pdf1.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="standards/standards.ps">
|
||||||
|
<IMG SRC="ps.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="standards/standards.dvi">
|
||||||
|
<IMG SRC="dvi.gif" HEIGHT=18 WIDTH=16></A>
|
||||||
|
<A HREF="standards/index.html">
|
||||||
|
GNU Coding Standards</A></LI>
|
||||||
|
</MENU>
|
||||||
|
</LI>
|
||||||
|
</MENU>
|
||||||
|
<HR>
|
||||||
|
Copyright © 1988-1998 <A HREF="http://www.oarcorp.com" target="Text Frame">OAR Corporation</A>
|
||||||
|
</BODY></HTML>
|
||||||
29
doc/gnu_docs/mk_install_dir
Normal file
29
doc/gnu_docs/mk_install_dir
Normal file
@@ -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
|
||||||
13
doc/gnu_docs/refcard.html
Normal file
13
doc/gnu_docs/refcard.html
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
<HTML>
|
||||||
|
<HEAD><TITLE>GDB Reference Card</TITLE></HEAD>
|
||||||
|
<BODY BGCOLOR="FFFFFF">
|
||||||
|
<A HREF="http://www.oarcorp.com" target="Text Frame">
|
||||||
|
<IMG align=right BORDER=0 SRC="../oaronly.jpg" ALT="OAR"> </A>
|
||||||
|
<H1>RTEMS On-Line Library</H1>
|
||||||
|
<HR>
|
||||||
|
<BODY>
|
||||||
|
The GDB Reference card is not written in texinfo file. There is currently
|
||||||
|
no HTML or PDF version of this file.
|
||||||
|
<HR>
|
||||||
|
Copyright © 1988-1999 <A HREF="http://www.oarcorp.com" target="Text Frame">OAR Corporation</A>
|
||||||
|
</BODY></HTML>
|
||||||
15
doc/gnu_docs/rtems_tools_index.html
Normal file
15
doc/gnu_docs/rtems_tools_index.html
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
<HTML>
|
||||||
|
<HEAD><TITLE>RTEMS and Tools On-Line Library</TITLE></HEAD>
|
||||||
|
<BODY BGCOLOR="FFFFFF">
|
||||||
|
<A HREF="http://www.oarcorp.com" target="Text Frame">
|
||||||
|
<IMG align=right BORDER=0 SRC="oaronly.jpg" ALT="OAR"> </A>
|
||||||
|
<H1>RTEMS 19991011 On-Line Library</H1>
|
||||||
|
<HR>
|
||||||
|
<BODY>
|
||||||
|
<MENU>
|
||||||
|
<LI><A HREF="rtems/html/index.html">RTEMS Documentation</A></LI>
|
||||||
|
<LI><A HREF="gnu/html/index.html">GNU Documentation</A></LI>
|
||||||
|
</MENU>
|
||||||
|
<HR>
|
||||||
|
Copyright © 1988-1998 <A HREF="http://www.oarcorp.com" target="Text Frame">OAR Corporation</A>
|
||||||
|
</BODY></HTML>
|
||||||
Reference in New Issue
Block a user