From fc76a6aa19af9606f260993811ac0dee8ec4e886 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Thu, 1 Jun 2000 15:29:01 +0000 Subject: Patch rtemsdoc-4.5.0-rc-8.diff from Ralf Corsepius . 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. --- doc/supplements/template/.cvsignore | 1 + doc/supplements/template/Makefile.am | 84 +++++++++++++++++----------------- doc/supplements/template/stamp-vti | 3 ++ doc/supplements/template/template.texi | 25 ++++------ doc/supplements/template/version.texi | 3 ++ 5 files changed, 57 insertions(+), 59 deletions(-) create mode 100644 doc/supplements/template/stamp-vti create mode 100644 doc/supplements/template/version.texi (limited to 'doc/supplements/template') diff --git a/doc/supplements/template/.cvsignore b/doc/supplements/template/.cvsignore index 2354989302..96541f861d 100644 --- a/doc/supplements/template/.cvsignore +++ b/doc/supplements/template/.cvsignore @@ -8,6 +8,7 @@ fatalerr.texi index.html intr.t intr.texi +mdate-sh memmodel.texi template template*.html diff --git a/doc/supplements/template/Makefile.am b/doc/supplements/template/Makefile.am index f50f7203a2..4edf460b1a 100644 --- a/doc/supplements/template/Makefile.am +++ b/doc/supplements/template/Makefile.am @@ -6,20 +6,20 @@ # $Id$ # -AUTOMAKE_OPTIONS = foreign +AUTOMAKE_OPTIONS = foreign 1.4 -PROJECT=template +PROJECT = template +EDITION = 1 include $(top_srcdir)/project.am include $(top_srcdir)/supplements/supplement.am -COMMON_FILES= $(top_srcdir)/common/cpright.texi $(top_builddir)/common/setup.texi +GENERATED_FILES = cpumodel.texi callconv.texi memmodel.texi intr.texi \ + fatalerr.texi bsp.texi cputable.texi wksheets.texi timing.texi \ + timeBSP.texi +COMMON_FILES = $(top_srcdir)/common/setup.texi $(top_srcdir)/common/cpright.texi -GENERATED_FILES=\ - cpumodel.texi callconv.texi memmodel.texi intr.texi fatalerr.texi \ - bsp.texi cputable.texi wksheets.texi timing.texi timeBSP.texi - -FILES= preface.texi +FILES = preface.texi info_TEXINFOS = template.texi template_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) @@ -27,64 +27,63 @@ template_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) # # Chapters which get automatic processing # -cpumodel.texi: cpumodel.t - $(BMENU) -p "Preface" \ + +$(srcdir)/cpumodel.texi: cpumodel.t + $(BMENU2) -p "Preface" \ -u "Top" \ - -n "Calling Conventions" $< + -n "Calling Conventions" < $< > $@ -callconv.texi: callconv.t - $(BMENU) -p "CPU Model Dependent Features Another Optional Feature" \ +$(srcdir)/callconv.texi: callconv.t + $(BMENU2) -p "CPU Model Dependent Features Another Optional Feature" \ -u "Top" \ - -n "Memory Model" $< + -n "Memory Model" < $< > $@ -memmodel.texi: memmodel.t - $(BMENU) -p "Calling Conventions User-Provided Routines" \ +$(srcdir)/memmodel.texi: memmodel.t + $(BMENU2) -p "Calling Conventions User-Provided Routines" \ -u "Top" \ - -n "Interrupt Processing" $< + -n "Interrupt Processing" < $< > $@ # Interrupt Chapter: # 1. Replace Times and Sizes # 2. Build Node Structure -intr.texi: intr_NOTIMES.t BSP_TIMES - ${REPLACE2} -p $(srcdir)/BSP_TIMES $(srcdir)/intr_NOTIMES.t intr.t - $(BMENU) -p "Memory Model Flat Memory Model" \ +$(srcdir)/intr.texi: intr_NOTIMES.t BSP_TIMES + ${REPLACE2} -p $(srcdir)/BSP_TIMES $(srcdir)/intr_NOTIMES.t | \ + $(BMENU2) -p "Memory Model Flat Memory Model" \ -u "Top" \ - -n "Default Fatal Error Processing" intr.t -CLEANFILES += intr.t + -n "Default Fatal Error Processing" > $@ -fatalerr.texi: fatalerr.t - $(BMENU) -p "Interrupt Processing Interrupt Stack" \ +$(srcdir)/fatalerr.texi: fatalerr.t + $(BMENU2) -p "Interrupt Processing Interrupt Stack" \ -u "Top" \ - -n "Board Support Packages" $< + -n "Board Support Packages" < $< > $@ -bsp.texi: bsp.t - $(BMENU) -p "Default Fatal Error Processing Default Fatal Error Handler Operations" \ +$(srcdir)/bsp.texi: bsp.t + $(BMENU2) -p "Default Fatal Error Processing Default Fatal Error Handler Operations" \ -u "Top" \ - -n "Processor Dependent Information Table" $< + -n "Processor Dependent Information Table" < $< > $@ -cputable.texi: cputable.t - $(BMENU) -p "Board Support Packages Processor Initialization" \ +$(srcdir)/cputable.texi: cputable.t + $(BMENU2) -p "Board Support Packages Processor Initialization" \ -u "Top" \ - -n "Memory Requirements" $< + -n "Memory Requirements" < $< > $@ # Worksheets Chapter: # 1. Obtain the Shared File # 2. Replace Times and Sizes # 3. Build Node Structure -wksheets.texi: $(top_srcdir)/common/wksheets.t BSP_TIMES +$(srcdir)/wksheets.texi: $(top_srcdir)/common/wksheets.t BSP_TIMES ${REPLACE2} -p $(srcdir)/BSP_TIMES \ - $(top_srcdir)/common/wksheets.t wksheets.t - $(BMENU) -p "Processor Dependent Information Table CPU Dependent Information Table" \ + $(top_srcdir)/common/wksheets.t | \ + $(BMENU2) -p "Processor Dependent Information Table CPU Dependent Information Table" \ -u "Top" \ - -n "Timing Specification" wksheets.t -CLEANFILES += wksheets.t + -n "Timing Specification" > $@ # Timing Specification Chapter: # 1. Copy the Shared File # 3. Build Node Structure -timing.texi: $(top_srcdir)/common/timing.t +$(srcdir)/timing.texi: $(top_srcdir)/common/timing.t $(BMENU2) -p "Memory Requirements RTEMS RAM Workspace Worksheet" \ -u "Top" \ -n "MYBSP Timing Data" < $< > $@ @@ -94,17 +93,16 @@ timing.texi: $(top_srcdir)/common/timing.t # 2. Replace Times and Sizes # 3. Build Node Structure -timeBSP.texi: $(top_srcdir)/common/timetbl.t timeBSP.t +$(srcdir)/timeBSP.texi: $(top_srcdir)/common/timetbl.t timeBSP.t cat timeBSP.t $(top_srcdir)/common/timetbl.t >timeBSP_.t @echo >>timeBSP_.t @echo "@tex" >>timeBSP_.t @echo "\\global\\advance \\smallskipamount by 4pt" >>timeBSP_.t @echo "@end tex" >>timeBSP_.t - ${REPLACE2} -p BSP_TIMES timeBSP_.t timeBSP_.t - $(BMENU) -p "Timing Specification Terminology" \ + ${REPLACE2} -p BSP_TIMES timeBSP_.t | \ + $(BMENU2) -p "Timing Specification Terminology" \ -u "Top" \ - -n "Command and Variable Index" timeBSP_.t - mv timeBSP_.texi timeBSP.texi -CLEANFILES += timeBSP_.t timeBSP_.texi + -n "Command and Variable Index" > $@ +CLEANFILES += timeBSP_.t EXTRA_DIST = BSP_TIMES *.t diff --git a/doc/supplements/template/stamp-vti b/doc/supplements/template/stamp-vti new file mode 100644 index 0000000000..27e5ccd0cb --- /dev/null +++ b/doc/supplements/template/stamp-vti @@ -0,0 +1,3 @@ +@set UPDATED 1 June 2000 +@set EDITION 1 +@set VERSION 4.5.0-beta3 diff --git a/doc/supplements/template/template.texi b/doc/supplements/template/template.texi index ce9e950f17..3cb9bfd02d 100644 --- a/doc/supplements/template/template.texi +++ b/doc/supplements/template/template.texi @@ -19,27 +19,20 @@ @c Master file for the Template Applications Supplement @c +@include version.texi @include ../../common/setup.texi -@ignore -@ifinfo -@format -START-INFO-DIR-ENTRY -* RTEMS Template Applications Supplement (template): -END-INFO-DIR-ENTRY -@end format -@end ifinfo -@end ignore +@ifset use-ascii +@dircategory RTEMS Target Supplements +@direntry +* RTEMS Template Applications Supplement: (template). +@end direntry +@end ifset @c @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 @@ -51,9 +44,9 @@ END-INFO-DIR-ENTRY @finalout @title RTEMS Template Applications Supplement -@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 diff --git a/doc/supplements/template/version.texi b/doc/supplements/template/version.texi new file mode 100644 index 0000000000..27e5ccd0cb --- /dev/null +++ b/doc/supplements/template/version.texi @@ -0,0 +1,3 @@ +@set UPDATED 1 June 2000 +@set EDITION 1 +@set VERSION 4.5.0-beta3 -- cgit v1.2.3