summaryrefslogtreecommitdiffstats
path: root/doc/networking
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2000-04-26 18:02:26 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2000-04-26 18:02:26 +0000
commit2ba8875a0b268d572ef2a27584d3f845ec1391b0 (patch)
tree70279d7624be264d69e3db5ab15a2af9278be0eb /doc/networking
parentbb4b574983e908329ff6feaff0a0e662ae621649 (diff)
downloadrtems-2ba8875a0b268d572ef2a27584d3f845ec1391b0.tar.bz2
Patch rtemsdoc-4.5.0-rc-0.diff from Ralf Corsepius <corsepiu@faw.uni-ulm.de>
which contains the bulk of converting the documentation tree to automake and GNU conventions. Comments follow: This is the automake port of rtemsdoc. To apply: cvs co rtemsdoc cd rtemsdoc sh cvs-rm.sh patch -p0 < rtemsdoc-4.5.0-rc-0.diff sh cvs-add.sh [Attention: cvs-rm.sh and cvs-add.sh directly modify cvs] Known bugs: 1) src2html is not supported (yet? - Is this supposed to work?) 2) all *.pdf images now are generated on-the-fly, but not yet deleted during "make distclean" 3) All supplements, including the templated ones, get build and installed. 4) Building outside of the source tree is completely untested and very likely does not work. 5) Make [ps|pdf] are not (yet) supported, make [dvi|info] are supported by automake's default texinfo rules. Fixing 2, 3 and 5 is almost trivial and needs to be done. 4) is a matter of testing and tool-properties, for now it is simply untested. General issues: * gif vs jpg vs png. I would recommend to replace all images with pngs to avoid potential copyright issues (gif) or lack in quality (jpg, jpg is good for real world photographs, but extremely poor on artificial images, graphs). * pdf images do net get placed correctly in pdf-documents. * texinfo: We now use a local copy of texinfo-4.0's texinfo.tex in texinfo/texinfo.tex for generating infos. However pdftex's system-wide texinfo.tex and pdftexinfo.tex are used for generating *.dvi, *.ps, *.pdf. * .cvsignore files still missing. * I have renamed the supplements filename not to use c_<supplement>, because automake seems to have problems with it. Notes: * Again, I recommend not to put any generated files into CVS. Here, this comprises some *texi, all *.pdf and many *.html pages. Ie. I recommend to run make maintainer-clean before checking in any files. * To get building started, this should be sufficient: ./bootstrap ./configure cd tools; make; cd .. make info * To make a public tarball: [cvs co ; ./bootstrap] ./configure cd tools; make; cd .. make info [make clean] make dist => This generates a rtems-<version>.tar.gz in the toplevel directory. => Building the tools only is required after a "cvs co", but not in a distribution tarball.
Diffstat (limited to 'doc/networking')
-rw-r--r--doc/networking/Makefile109
-rw-r--r--doc/networking/Makefile.am71
-rw-r--r--doc/networking/PCIreg.pdfbin1906 -> 0 bytes
-rw-r--r--doc/networking/decdriver.t2
-rw-r--r--doc/networking/networkflow.pdfbin19170 -> 0 bytes
-rw-r--r--doc/networking/networktasks.t9
-rw-r--r--doc/networking/recvbd.pdfbin1101 -> 0 bytes
7 files changed, 73 insertions, 118 deletions
diff --git a/doc/networking/Makefile b/doc/networking/Makefile
deleted file mode 100644
index a87d6fdf11..0000000000
--- a/doc/networking/Makefile
+++ /dev/null
@@ -1,109 +0,0 @@
-#
-# COPYRIGHT (c) 1988-1999.
-# On-Line Applications Research Corporation (OAR).
-# All rights reserved.
-#
-# $Id$
-#
-
-PROJECT=networking
-
-include ../Make.config
-
-REPLACE=../tools/word-replace
-
-BMENU+= -c
-
-all: html info ps pdf
-
-dirs:
- $(make-dirs)
-
-COMMON_FILES=../common/cpright.texi ../common/setup.texi
-
-GENERATED_FILES=networkapp.texi driver.texi networktasks.texi testing.texi \
- servers.texi decdriver.texi
-
-FILES= $(PROJECT).texi \
- networktasks.texi preface.texi $(GENERATED_FILES)
-
-INFOFILES=$(wildcard $(PROJECT) $(PROJECT)-*)
-
-info: dirs $(PROJECT)
- #cp $(wildcard $(PROJECT) $(PROJECT)-*) $(INFO_INSTALL)
- cp $(PROJECT) $(INFO_INSTALL)
-
-$(PROJECT): $(FILES)
- $(MAKEINFO) $(PROJECT).texi
-
-dvi: dirs $(PROJECT).dvi
-ps: dirs $(PROJECT).ps
-pdf: dirs $(PROJECT).pdf
-
-$(PROJECT).pdf: $(FILES)
- $(TEXI2PDF) $(PROJECT).texi
- cp $(PROJECT).pdf $(WWW_INSTALL)/$(PROJECT)
-
-$(PROJECT).ps: $(PROJECT).dvi
- dvips -o $(PROJECT).ps $(PROJECT).dvi
- cp $(PROJECT).ps $(WWW_INSTALL)/$(PROJECT)
-
-$(PROJECT).dvi: $(FILES)
- $(TEXI2DVI) $(PROJECT).texi
- cp $(PROJECT).dvi $(WWW_INSTALL)/$(PROJECT)
-
-networktasks.texi: networktasks.t Makefile
- $(BMENU) -p "Preface" \
- -u "Top" \
- -n "Networking Driver" ${*}.t
-
-driver.texi: driver.t Makefile
- $(BMENU) -p "Network Task Structure and Data Flow" \
- -u "Top" \
- -n "Using Networking in an RTEMS Application" ${*}.t
-
-networkapp.texi: networkapp.t Makefile
- $(BMENU) -p "Write the Driver Statistic-Printing Function" \
- -u "Top" \
- -n "Testing the Driver" ${*}.t
-
-testing.texi: testing.t Makefile
- $(BMENU) -p "Time Synchronization Using NTP" \
- -u "Top" \
- -n "Network Servers" ${*}.t
-
-servers.texi: servers.t Makefile
- $(BMENU) -p "Throughput" \
- -u "Top" \
- -n "DEC 21140 Driver" ${*}.t
-
-decdriver.texi: decdriver.t Makefile
- $(BMENU) -p "Using Hooks" \
- -u "Top" \
- -n "Command and Variable Index" ${*}.t
-
-html: dirs $(FILES)
- -mkdir -p $(WWW_INSTALL)/$(PROJECT)
- rm -f $(WWW_INSTALL)/$(PROJECT)/networkflow.jpg
- rm -f $(WWW_INSTALL)/$(PROJECT)/networkflow.png
- rm -f $(WWW_INSTALL)/$(PROJECT)/PCIreg.jpg
- cp recvbd.jpg $(WWW_INSTALL)/$(PROJECT)/recvbd.jpg
- cp networkflow.jpg $(WWW_INSTALL)/$(PROJECT)/networkflow.jpg
- cp networkflow.png $(WWW_INSTALL)/$(PROJECT)/networkflow.png
- cp PCIreg.jpg $(WWW_INSTALL)/$(PROJECT)/PCIreg.jpg
- $(TEXI2WWW) $(TEXI2WWW_ARGS) -dir $(WWW_INSTALL)/$(PROJECT) \
- $(PROJECT).texi
-
-clean:
- rm -f *.o $(PROG) *.txt core $(PROJECT).pdf
- rm -f *.dvi *.ps *.log *.aux *.cp *.fn *.ky *.pg *.toc *.tp *.vr $(BASE)
- rm -f $(PROJECT) $(PROJECT)-* $(GENERATED_FILES)
- rm -f $(PROJECT) $(PROJECT)-*
- rm -f timedata.texi timetbl.texi intr.texi wksheets.texi
- rm -f timetbl.t wksheets.t
- rm -f *.fixed _*
-
-convert:
- /usr/bin/gs -dMaxBitmap=300000000 -g5500x7500 -sDEVICE=pdfwrite -q -dNOPAUSE -dSAFER -sOutputFile=networkflow.pdf -- networkflow.eps -c -quit
- /usr/bin/gs -dMaxBitmap=300000000 -g4500x5500 -sDEVICE=pdfwrite -q -dNOPAUSE -dSAFER -sOutputFile=PCIreg.pdf -- PCIreg.eps -c -quit
- /usr/bin/gs -dMaxBitmap=300000000 -g4500x5500 -sDEVICE=pdfwrite -q -dNOPAUSE -dSAFER -sOutputFile=recvbd.pdf -- recvbd.eps -c -quit
diff --git a/doc/networking/Makefile.am b/doc/networking/Makefile.am
new file mode 100644
index 0000000000..42c499b219
--- /dev/null
+++ b/doc/networking/Makefile.am
@@ -0,0 +1,71 @@
+#
+# COPYRIGHT (c) 1988-1999.
+# On-Line Applications Research Corporation (OAR).
+# All rights reserved.
+#
+# $Id$
+#
+
+AUTOMAKE_OPTIONS = foreign
+
+PROJECT=networking
+
+include $(top_srcdir)/project.am
+
+# FIXME: Why -c ?
+BMENU+= -c
+
+COMMON_FILES=$(top_srcdir)/common/cpright.texi $(top_builddir)/common/setup.texi
+
+GENERATED_FILES=networkapp.texi driver.texi networktasks.texi testing.texi \
+ servers.texi decdriver.texi
+
+FILES= networktasks.texi preface.texi
+
+info_TEXINFOS = networking.texi
+networking_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES)
+
+$(PROJECT).dvi: networkflow.eps PCIreg.eps recvbd.eps
+
+$(PROJECT).pdf: networkflow.pdf PCIreg.pdf recvbd.pdf
+
+if USE_HTML
+html_project_DATA += networkflow.jpg networkflow.png PCIreg.jpg recvbd.jpg
+endif
+
+networktasks.texi: networktasks.t
+ $(BMENU) -p "Preface" \
+ -u "Top" \
+ -n "Networking Driver" $<
+
+driver.texi: driver.t
+ $(BMENU) -p "Network Task Structure and Data Flow" \
+ -u "Top" \
+ -n "Using Networking in an RTEMS Application" $<
+
+networkapp.texi: networkapp.t
+ $(BMENU) -p "Write the Driver Statistic-Printing Function" \
+ -u "Top" \
+ -n "Testing the Driver" $<
+
+testing.texi: testing.t
+ $(BMENU) -p "Time Synchronization Using NTP" \
+ -u "Top" \
+ -n "Network Servers" $<
+
+servers.texi: servers.t
+ $(BMENU) -p "Throughput" \
+ -u "Top" \
+ -n "DEC 21140 Driver" $<
+
+decdriver.texi: decdriver.t
+ $(BMENU) -p "Using Hooks" \
+ -u "Top" \
+ -n "Command and Variable Index" $<
+
+PICTURE_FILES = \
+PCIreg.eps PCIreg.jpg \
+networkflow.eps networkflow.jpg networkflow.png \
+recvbd.eps recvbd.jpg
+
+EXTRA_DIST = *.t $(PICTURE_FILES)
diff --git a/doc/networking/PCIreg.pdf b/doc/networking/PCIreg.pdf
deleted file mode 100644
index 5fbb991e26..0000000000
--- a/doc/networking/PCIreg.pdf
+++ /dev/null
Binary files differ
diff --git a/doc/networking/decdriver.t b/doc/networking/decdriver.t
index 7a0fd0c4a3..f9fdbd778e 100644
--- a/doc/networking/decdriver.t
+++ b/doc/networking/decdriver.t
@@ -80,7 +80,7 @@ There is no ASCII version of the PCI Device's Configuration Header Space Format
@end ifset
@ifset use-tex
-@image{PCIreg,,}
+@image{PCIreg}
@end ifset
@c @image{PCIreg}
diff --git a/doc/networking/networkflow.pdf b/doc/networking/networkflow.pdf
deleted file mode 100644
index b8c6cf9ab9..0000000000
--- a/doc/networking/networkflow.pdf
+++ /dev/null
Binary files differ
diff --git a/doc/networking/networktasks.t b/doc/networking/networktasks.t
index b9760301e1..a6cf9a0683 100644
--- a/doc/networking/networktasks.t
+++ b/doc/networking/networktasks.t
@@ -23,14 +23,7 @@ NO ASCII VERSION OF THE TASKING FIGURE IS AVAILABLE
@end ifset
@ifset use-tex
-@c for now use the ascii version
-@example
-@group
-@c why does this not work for pdf?
-@c @image{networkflow,5in,6in}
-NO TEX VERSION OF THE TASKING FIGURE IS AVAILABLE
-@end group
-@end example
+@image{networkflow,5in,6in}
@end ifset
@ifset use-html
diff --git a/doc/networking/recvbd.pdf b/doc/networking/recvbd.pdf
deleted file mode 100644
index 1825846f79..0000000000
--- a/doc/networking/recvbd.pdf
+++ /dev/null
Binary files differ