Patch rtemsdoc-4.5.0-rc-8.diff from Ralf Corsepius <corsepiu@faw.uni-ulm.de>.

Ralf's comments follow:

  Changes:
    * Enhanced versioning:
      - Addition of automake's version.texi support
      - Replacement of rtemsdoc's former versioning support by automake's
        versioning support (Abandoning RTEMS-UPDATE-* etc.)
      - Abandoning setup.texi.in
      - Add EDITION to each documents Makefile.am
      - version.texi support in project.am
      - Addition of maintainer mode (currently only used to prevent incorrectly
        updating timestamps when users touch automake's version.texi timestamp
        files (stamp-vti)).

    * Fixing info dir support
      - Use texinfo's @dircategory and @direntry instead of infos *-DIR-ENTRY
      - $(infodir)/dir is now correctly set up

    * Avoid using temporary files
      - Pipe texts through REPLACE2 into BMENU2 instead of using temporary files.
      - Abandon using bmenu in favor of bmenu2 (bmenu could be removed now)

    * Prepare Makefile.ams for building in a separate buildtree
      - prefix files with $(srcdir) in Makefile.am for files which must be
        generated inside of the source tree

  Notes:
    * rtemsdoc can not yet be build in a separate source-tree, but we
      are very close to it.
    * You as the maintainer of this package now should always use
      --enable-maintainer-mode to configure rtemsdoc.
This commit is contained in:
Joel Sherrill
2000-06-01 15:29:01 +00:00
parent c849746bad
commit fc76a6aa19
140 changed files with 1488 additions and 1594 deletions

View File

@@ -30,6 +30,7 @@ index.html
init.texi
intr.texi
io.texi
mdate-sh
mp.texi
msg.texi
overview.texi

View File

@@ -6,24 +6,24 @@
# $Id$
#
AUTOMAKE_OPTIONS = foreign
AUTOMAKE_OPTIONS = foreign 1.4
PROJECT=c_user
PROJECT = c_user
EDITION = 1
include $(top_srcdir)/project.am
COMMON_FILES=$(top_srcdir)/common/cpright.texi
FILES = bsp.texi dirstat.texi example.texi glossary.texi preface.texi
FILES= bsp.texi dirstat.texi example.texi glossary.texi preface.texi
GENERATED_FILES = overview.texi concepts.texi datatypes.texi init.texi \
task.texi intr.texi clock.texi timer.texi sem.texi msg.texi event.texi \
signal.texi part.texi region.texi dpmem.texi io.texi fatal.texi \
schedule.texi rtmon.texi bsp.texi userext.texi conf.texi mp.texi
GENERATED_FILES=overview.texi concepts.texi datatypes.texi init.texi \
task.texi intr.texi clock.texi timer.texi sem.texi msg.texi \
event.texi signal.texi part.texi region.texi \
dpmem.texi io.texi fatal.texi schedule.texi rtmon.texi \
bsp.texi userext.texi conf.texi mp.texi
COMMON_FILES = $(top_srcdir)/common/setup.texi $(top_srcdir)/common/cpright.texi
info_TEXINFOS = c_user.texi
c_user_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES)
c_user_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES)
PNG_FILES = rtemsarc.png rtemspie.png states.png
@@ -31,137 +31,132 @@ EPS_IMAGES = rtemspie.eps states.eps
$(PROJECT).dvi: $(EPS_IMAGES)
PDF_IMAGES = rtemspie.pdf states.pdf
CLEANFILES += $(PDF_IMAGES)
if USE_HTML
html_project_DATA += $(PNG_FILES)
endif
#preface.texi: preface.t
# $(BMENU) -p "Top" \
# -u "Top" \
# -n "Overview" $<
overview.texi: overview.t
$(BMENU) -p "Preface" \
$(srcdir)/overview.texi: overview.t
$(BMENU2) -p "Preface" \
-u "Top" \
-n "Key Concepts" $<
-n "Key Concepts" < $< > $@
concepts.texi: concepts.t
$(BMENU) -p "Overview Manual Organization" \
$(srcdir)/concepts.texi: concepts.t
$(BMENU2) -p "Overview Manual Organization" \
-u "Top" \
-n "RTEMS Data Types" $<
-n "RTEMS Data Types" < $< > $@
datatypes.texi: datatypes.t
$(BMENU) -p "Key Concepts Memory Management" \
$(srcdir)/datatypes.texi: datatypes.t
$(BMENU2) -p "Key Concepts Memory Management" \
-u "Top" \
-n "Initialization Manager" $<
-n "Initialization Manager" < $< > $@
init.texi: init.t
$(BMENU) -p "RTEMS Data Types List of Data Types" \
$(srcdir)/init.texi: init.t
$(BMENU2) -p "RTEMS Data Types List of Data Types" \
-u "Top" \
-n "Task Manager" $<
-n "Task Manager" < $< > $@
task.texi: task.t
$(BMENU) -p "Initialization Manager SHUTDOWN_EXECUTIVE - Shutdown RTEMS" \
$(srcdir)/task.texi: task.t
$(BMENU2) -p "Initialization Manager SHUTDOWN_EXECUTIVE - Shutdown RTEMS" \
-u "Top" \
-n "Interrupt Manager" $<
-n "Interrupt Manager" < $< > $@
intr.texi: intr.t
$(BMENU) -p "Task Manager TASK_VARIABLE_DELETE - Remove per task variable" \
$(srcdir)/intr.texi: intr.t
$(BMENU2) -p "Task Manager TASK_VARIABLE_DELETE - Remove per task variable" \
-u "Top" \
-n "Clock Manager" $<
-n "Clock Manager" < $< > $@
clock.texi: clock.t
$(BMENU) \
$(srcdir)/clock.texi: clock.t
$(BMENU2) \
-p "Interrupt Manager INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress" \
-u "Top" \
-n "Timer Manager" $<
-n "Timer Manager" < $< > $@
timer.texi: timer.t
$(BMENU) -p "Clock Manager CLOCK_TICK - Announce a clock tick" \
$(srcdir)/timer.texi: timer.t
$(BMENU2) -p "Clock Manager CLOCK_TICK - Announce a clock tick" \
-u "Top" \
-n "Semaphore Manager" $<
-n "Semaphore Manager" < $< > $@
sem.texi: sem.t
$(BMENU) -p "Timer Manager TIMER_RESET - Reset an interval timer" \
$(srcdir)/sem.texi: sem.t
$(BMENU2) -p "Timer Manager TIMER_RESET - Reset an interval timer" \
-u "Top" \
-n "Message Manager" $<
-n "Message Manager" < $< > $@
msg.texi: msg.t
$(BMENU) -p "Semaphore Manager SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore" \
$(srcdir)/msg.texi: msg.t
$(BMENU2) -p "Semaphore Manager SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore" \
-u "Top" \
-n "Event Manager" $<
-n "Event Manager" < $< > $@
event.texi: event.t
$(BMENU) \
$(srcdir)/event.texi: event.t
$(BMENU2) \
-p "Message Manager MESSAGE_QUEUE_FLUSH - Flush all messages on a queue" \
-u "Top" \
-n "Signal Manager" $<
-n "Signal Manager" < $< > $@
signal.texi: signal.t
$(BMENU) -p "Event Manager EVENT_RECEIVE - Receive event condition" \
$(srcdir)/signal.texi: signal.t
$(BMENU2) -p "Event Manager EVENT_RECEIVE - Receive event condition" \
-u "Top" \
-n "Partition Manager" $<
-n "Partition Manager" < $< > $@
part.texi: part.t
$(BMENU) -p "Signal Manager SIGNAL_SEND - Send signal set to a task" \
$(srcdir)/part.texi: part.t
$(BMENU2) -p "Signal Manager SIGNAL_SEND - Send signal set to a task" \
-u "Top" \
-n "Region Manager" $<
-n "Region Manager" < $< > $@
region.texi: region.t
$(BMENU) \
$(srcdir)/region.texi: region.t
$(BMENU2) \
-p "Partition Manager PARTITION_RETURN_BUFFER - Return buffer to a partition" \
-u "Top" \
-n "Dual-Ported Memory Manager" $<
-n "Dual-Ported Memory Manager" < $< > $@
dpmem.texi: dpmem.t
$(BMENU) \
$(srcdir)/dpmem.texi: dpmem.t
$(BMENU2) \
-p "Region Manager REGION_GET_SEGMENT_SIZE - Obtain size of a segment" \
-u "Top" \
-n "I/O Manager" $<
-n "I/O Manager" < $< > $@
io.texi: io.t
$(BMENU) -p "Dual-Ported Memory Manager PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address" \
$(srcdir)/io.texi: io.t
$(BMENU2) -p "Dual-Ported Memory Manager PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address" \
-u "Top" \
-n "Fatal Error Manager" $<
-n "Fatal Error Manager" < $< > $@
fatal.texi: fatal.t
$(BMENU) -p "I/O Manager IO_CONTROL - Special device services" \
$(srcdir)/fatal.texi: fatal.t
$(BMENU2) -p "I/O Manager IO_CONTROL - Special device services" \
-u "Top" \
-n "Scheduling Concepts" $<
-n "Scheduling Concepts" < $< > $@
schedule.texi: schedule.t
$(BMENU) \
$(srcdir)/schedule.texi: schedule.t
$(BMENU2) \
-p "Fatal Error Manager FATAL_ERROR_OCCURRED - Invoke the fatal error handler" \
-u "Top" \
-n "Rate Monotonic Manager" $<
-n "Rate Monotonic Manager" < $< > $@
rtmon.texi: rtmon.t
$(BMENU) -p "Scheduling Concepts Task State Transitions" \
$(srcdir)/rtmon.texi: rtmon.t
$(BMENU2) -p "Scheduling Concepts Task State Transitions" \
-u "Top" \
-n "Board Support Packages" $<
-n "Board Support Packages" < $< > $@
bsp.texi: bsp.t
$(BMENU) -p "Rate Monotonic Manager RATE_MONOTONIC_GET_STATUS - Obtain status information on period" \
$(srcdir)/bsp.texi: bsp.t
$(BMENU2) -p "Rate Monotonic Manager RATE_MONOTONIC_GET_STATUS - Obtain status information on period" \
-u "Top" \
-n "User Extensions Manager" $<
-n "User Extensions Manager" < $< > $@
userext.texi: userext.t
$(BMENU) -p "Board Support Packages Heterogeneous Systems" \
$(srcdir)/userext.texi: userext.t
$(BMENU2) -p "Board Support Packages Heterogeneous Systems" \
-u "Top" \
-n "Configuring a System" $<
-n "Configuring a System" < $< > $@
conf.texi: conf.t
$(BMENU) -p "User Extensions Manager EXTENSION_DELETE - Delete a extension set" \
$(srcdir)/conf.texi: conf.t
$(BMENU2) -p "User Extensions Manager EXTENSION_DELETE - Delete a extension set" \
-u "Top" \
-n "Multiprocessing Manager" $<
-n "Multiprocessing Manager" < $< > $@
mp.texi: mp.t
$(BMENU) -p "Configuring a System Sizing the RTEMS RAM Workspace" \
$(srcdir)/mp.texi: mp.t
$(BMENU2) -p "Configuring a System Sizing the RTEMS RAM Workspace" \
-u "Top" \
-n "Directive Status Codes" $<
-n "Directive Status Codes" < $< > $@
noinst_DATA = \
states.gif rtemspie.gif
noinst_DATA = states.gif rtemspie.gif
EXTRA_DIST = *.t $(PNG_FILES) $(EPS_IMAGES) $(noinst_DATA)

View File

@@ -25,17 +25,15 @@
@c 2. Why does paragraphindent show up in HTML?
@c
@include version.texi
@include ../common/setup.texi
@ignore
@ifinfo
@format
START-INFO-DIR-ENTRY
* RTEMS C User: (c_user). The C User's Guide
END-INFO-DIR-ENTRY
@end format
@end ifinfo
@end ignore
@ifset use-ascii
@dircategory RTEMS On-Line Manual
@direntry
* RTEMS C User: (c_user). The C User's Guide.
@end direntry
@end ifset
@c @syncodeindex fn cp
@c variable substitution info:
@@ -56,11 +54,6 @@ END-INFO-DIR-ENTRY
@c Title Page Stuff
@c
@set edition @value{RTEMS-EDITION}
@set version @value{RTEMS-VERSION}
@set update-date @value{RTEMS-UPDATE-DATE}
@set update-month @value{RTEMS-UPDATE-MONTH}
@c
@c I don't really like having a short title page. --joel
@c
@@ -72,9 +65,9 @@ END-INFO-DIR-ENTRY
@finalout
@title RTEMS C User's Guide
@subtitle Edition @value{edition}, for RTEMS @value{version}
@subtitle Edition @value{EDITION}, for RTEMS @value{VERSION}
@sp 1
@subtitle @value{update-month}
@subtitle @value{UPDATED}
@author On-Line Applications Research Corporation
@page
@include ../common/cpright.texi

View File

@@ -184,6 +184,6 @@ Once approved, RTEMS will be made compliant.
This document is a detailed users guide for a
functionally compliant real-time multiprocessor executive. It
describes the user interface and run-time behavior of Release
@value{RTEMS-RELEASE} of the @value{LANGUAGE} interface
@value{VERSION} of the @value{LANGUAGE} interface
to RTEMS.

3
doc/user/stamp-vti Normal file
View File

@@ -0,0 +1,3 @@
@set UPDATED 1 June 2000
@set EDITION 1
@set VERSION 4.5.0-beta3

3
doc/user/version.texi Normal file
View File

@@ -0,0 +1,3 @@
@set UPDATED 1 June 2000
@set EDITION 1
@set VERSION 4.5.0-beta3