path: root/doc/user
diff options
authorJoel Sherrill <>2000-04-26 18:02:26 +0000
committerJoel Sherrill <>2000-04-26 18:02:26 +0000
commit2ba8875a0b268d572ef2a27584d3f845ec1391b0 (patch)
tree70279d7624be264d69e3db5ab15a2af9278be0eb /doc/user
parentbb4b574983e908329ff6feaff0a0e662ae621649 (diff)
Patch rtemsdoc-4.5.0-rc-0.diff from Ralf Corsepius <>
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 patch -p0 < rtemsdoc-4.5.0-rc-0.diff sh [Attention: and 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/user')
-rw-r--r--doc/user/ (renamed from doc/user/Makefile)115
-rw-r--r--doc/user/rtemspie.pdfbin5715766 -> 0 bytes
-rw-r--r--doc/user/states.pdfbin488333 -> 0 bytes
3 files changed, 39 insertions, 76 deletions
diff --git a/doc/user/Makefile b/doc/user/
index 1e4cc53234..fc81acf71c 100644
--- a/doc/user/Makefile
+++ b/doc/user/
@@ -6,21 +6,15 @@
# $Id$
-include ../Make.config
-all: html info ps pdf
+include $(top_srcdir)/
- $(make-dirs)
-FILES= bsp.texi c_user.texi clock.texi concepts.texi conf.texi \
- dirstat.texi dpmem.texi event.texi example.texi fatal.texi \
- glossary.texi init.texi intr.texi io.texi mp.texi msg.texi overview.texi \
- part.texi preface.texi region.texi rtmon.texi schedule.texi sem.texi \
- signal.texi task.texi timer.texi userext.texi $(COMMON_FILES)
+FILES= bsp.texi dirstat.texi example.texi glossary.texi preface.texi
GENERATED_FILES=overview.texi concepts.texi init.texi task.texi \
intr.texi clock.texi timer.texi sem.texi msg.texi \
@@ -28,167 +22,136 @@ GENERATED_FILES=overview.texi concepts.texi init.texi task.texi \
dpmem.texi io.texi fatal.texi schedule.texi rtmon.texi \
bsp.texi userext.texi conf.texi mp.texi
-INFOFILES=$(wildcard $(PROJECT) $(PROJECT)-*)
-info: dirs $(PROJECT)
-dvi: dirs $(PROJECT).dvi
-ps: dirs $(PROJECT).ps
-pdf: dirs $(PROJECT).pdf
-$(PROJECT).pdf: $(FILES)
- $(TEXI2PDF) $(PROJECT).texi
-$(PROJECT).ps: $(PROJECT).dvi
- dvips -o $(PROJECT).ps $(PROJECT).dvi
-$(PROJECT).dvi: $(FILES)
- $(TEXI2DVI) $(PROJECT).texi
-html: dirs $(FILES)
- -mkdir -p $(WWW_INSTALL)/$(PROJECT)
- cp rtemsarc.png rtemspie.png states.png $(WWW_INSTALL)/c_user
- $(PROJECT).texi
- texindex $(PROJECT).cp $(PROJECT).vr $(PROJECT).fn \
- $(PROJECT).tp $(PROJECT).pg $(PROJECT).ky
- rm -f *.o $(PROG) *.txt core *.html $(PROJECT).pdf
- rm -f *.dvi *.ps *.log *.aux *.cp *.fn *.ky *.pg *.toc *.tp *.vr $(BASE)
- rm -f *.cps *.cpss *.fns *.kys *.pgs *.tps *.vrs
+info_TEXINFOS = c_user.texi
+PNG_FILES = rtemsarc.png rtemspie.png states.png
+html_project_DATA += $(PNG_FILES)
#preface.texi: preface.t
# $(BMENU) -p "Top" \
# -u "Top" \
-# -n "Overview" ${*}.t
+# -n "Overview" $<
overview.texi: overview.t
$(BMENU) -p "Preface" \
-u "Top" \
- -n "Key Concepts" ${*}.t
+ -n "Key Concepts" $<
concepts.texi: concepts.t
$(BMENU) -p "Overview Manual Organization" \
-u "Top" \
- -n "Initialization Manager" ${*}.t
+ -n "Initialization Manager" $<
init.texi: init.t
$(BMENU) -p "Key Concepts Memory Management" \
-u "Top" \
- -n "Task Manager" ${*}.t
+ -n "Task Manager" $<
task.texi: task.t
$(BMENU) -p "Initialization Manager SHUTDOWN_EXECUTIVE - Shutdown RTEMS" \
-u "Top" \
- -n "Interrupt Manager" ${*}.t
+ -n "Interrupt Manager" $<
intr.texi: intr.t
$(BMENU) -p "Task Manager TASK_VARIABLE_DELETE - Remove per task variable" \
-u "Top" \
- -n "Clock Manager" ${*}.t
+ -n "Clock Manager" $<
clock.texi: clock.t
$(BMENU) \
-p "Interrupt Manager INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress" \
-u "Top" \
- -n "Timer Manager" ${*}.t
+ -n "Timer Manager" $<
timer.texi: timer.t
$(BMENU) -p "Clock Manager CLOCK_TICK - Announce a clock tick" \
-u "Top" \
- -n "Semaphore Manager" ${*}.t
+ -n "Semaphore Manager" $<
sem.texi: sem.t
$(BMENU) -p "Timer Manager TIMER_RESET - Reset an interval timer" \
-u "Top" \
- -n "Message Manager" ${*}.t
+ -n "Message Manager" $<
msg.texi: msg.t
$(BMENU) -p "Semaphore Manager SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore" \
-u "Top" \
- -n "Event Manager" ${*}.t
+ -n "Event Manager" $<
event.texi: event.t
$(BMENU) \
-p "Message Manager MESSAGE_QUEUE_FLUSH - Flush all messages on a queue" \
-u "Top" \
- -n "Signal Manager" ${*}.t
+ -n "Signal Manager" $<
signal.texi: signal.t
$(BMENU) -p "Event Manager EVENT_RECEIVE - Receive event condition" \
-u "Top" \
- -n "Partition Manager" ${*}.t
+ -n "Partition Manager" $<
part.texi: part.t
$(BMENU) -p "Signal Manager SIGNAL_SEND - Send signal set to a task" \
-u "Top" \
- -n "Region Manager" ${*}.t
+ -n "Region Manager" $<
region.texi: region.t
$(BMENU) \
-p "Partition Manager PARTITION_RETURN_BUFFER - Return buffer to a partition" \
-u "Top" \
- -n "Dual-Ported Memory Manager" ${*}.t
+ -n "Dual-Ported Memory Manager" $<
dpmem.texi: dpmem.t
$(BMENU) \
-p "Region Manager REGION_GET_SEGMENT_SIZE - Obtain size of a segment" \
-u "Top" \
- -n "I/O Manager" ${*}.t
+ -n "I/O Manager" $<
io.texi: io.t
$(BMENU) -p "Dual-Ported Memory Manager PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address" \
-u "Top" \
- -n "Fatal Error Manager" ${*}.t
+ -n "Fatal Error Manager" $<
fatal.texi: fatal.t
$(BMENU) -p "I/O Manager IO_CONTROL - Special device services" \
-u "Top" \
- -n "Scheduling Concepts" ${*}.t
+ -n "Scheduling Concepts" $<
schedule.texi: schedule.t
$(BMENU) \
-p "Fatal Error Manager FATAL_ERROR_OCCURRED - Invoke the fatal error handler" \
-u "Top" \
- -n "Rate Monotonic Manager" ${*}.t
+ -n "Rate Monotonic Manager" $<
rtmon.texi: rtmon.t
$(BMENU) -p "Scheduling Concepts Task State Transitions" \
-u "Top" \
- -n "Board Support Packages" ${*}.t
+ -n "Board Support Packages" $<
bsp.texi: bsp.t
$(BMENU) -p "Rate Monotonic Manager RATE_MONOTONIC_GET_STATUS - Obtain status information on period" \
-u "Top" \
- -n "User Extensions Manager" ${*}.t
+ -n "User Extensions Manager" $<
userext.texi: userext.t
$(BMENU) -p "Board Support Packages Heterogeneous Systems" \
-u "Top" \
- -n "Configuring a System" ${*}.t
+ -n "Configuring a System" $<
conf.texi: conf.t
$(BMENU) -p "User Extensions Manager EXTENSION_DELETE - Delete a extension set" \
-u "Top" \
- -n "Multiprocessing Manager" ${*}.t
+ -n "Multiprocessing Manager" $<
mp.texi: mp.t
$(BMENU) -p "Configuring a System Sizing the RTEMS RAM Workspace" \
-u "Top" \
- -n "Directive Status Codes" ${*}.t
+ -n "Directive Status Codes" $<
+noinst_DATA = \
+states.gif states.eps \
+rtemspie.gif rtemspie.eps
- /usr/bin/gs -dMaxBitmap=300000000 -g5500x5500 -sDEVICE=pdfwrite -q -dNOPAUSE -dSAFER -sOutputFile=rtemspie.pdf -- rtemspie.eps -c -quit
- /usr/bin/gs -dMaxBitmap=300000000 -g5500x5500 -sDEVICE=pdfwrite -q -dNOPAUSE -dSAFER -sOutputFile=states.pdf -- states.eps -c -quit
+EXTRA_DIST = *.t $(PNG_FILES) $(noinst_DATA)
diff --git a/doc/user/rtemspie.pdf b/doc/user/rtemspie.pdf
deleted file mode 100644
index ad64183eed..0000000000
--- a/doc/user/rtemspie.pdf
+++ /dev/null
Binary files differ
diff --git a/doc/user/states.pdf b/doc/user/states.pdf
deleted file mode 100644
index 490d2e00cd..0000000000
--- a/doc/user/states.pdf
+++ /dev/null
Binary files differ