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/rtems_gdb/.cvsignore | 1 + doc/rtems_gdb/Makefile.am | 51 ++++++++++++++++++++++---------------------- doc/rtems_gdb/rtems_gdb.texi | 25 ++++++++-------------- doc/rtems_gdb/stamp-vti | 3 +++ doc/rtems_gdb/version.texi | 3 +++ 5 files changed, 42 insertions(+), 41 deletions(-) create mode 100644 doc/rtems_gdb/stamp-vti create mode 100644 doc/rtems_gdb/version.texi (limited to 'doc/rtems_gdb') diff --git a/doc/rtems_gdb/.cvsignore b/doc/rtems_gdb/.cvsignore index d11ab103c3..c568488e2c 100644 --- a/doc/rtems_gdb/.cvsignore +++ b/doc/rtems_gdb/.cvsignore @@ -4,6 +4,7 @@ commands.texi example.texi index.html intro.texi +mdate-sh rtems_gdb rtems_gdb*.html rtems_gdb.aux diff --git a/doc/rtems_gdb/Makefile.am b/doc/rtems_gdb/Makefile.am index 78c7c9feaf..782a151b00 100644 --- a/doc/rtems_gdb/Makefile.am +++ b/doc/rtems_gdb/Makefile.am @@ -6,54 +6,55 @@ # $Id$ # -AUTOMAKE_OPTIONS = foreign +AUTOMAKE_OPTIONS = foreign 1.4 -PROJECT=rtems_gdb +PROJECT = rtems_gdb +EDITION = 1 include $(top_srcdir)/project.am -COMMON_FILES=$(top_srcdir)/common/cpright.texi $(top_builddir)/common/setup.texi +GENERATED_FILES = intro.texi swarch.texi started.texi commands.texi \ + trouble.texi example.texi -GENERATED_FILES= \ - intro.texi swarch.texi started.texi commands.texi trouble.texi example.texi +COMMON_FILES = $(top_srcdir)/common/setup.texi $(top_srcdir)/common/cpright.texi -FILES= +FILES = info_TEXINFOS = rtems_gdb.texi -rtems_gdb_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) +rtems_gdb_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) # # Process Automatically Generated Files # -intro.texi: intro.t - $(BMENU) -p "Top" \ +$(srcdir)/intro.texi: intro.t + $(BMENU2) -p "Top" \ -u "Top" \ - -n "Software Architecture" $< + -n "Software Architecture" < $< > $@ -swarch.texi: swarch.t - $(BMENU) -p "Introduction" \ +$(srcdir)/swarch.texi: swarch.t + $(BMENU2) -p "Introduction" \ -u "Top" \ - -n "Getting Started" $< + -n "Getting Started" < $< > $@ -started.texi: started.t - $(BMENU) -p "Software Architecture" \ +$(srcdir)/started.texi: started.t + $(BMENU2) -p "Software Architecture" \ -u "Top" \ - -n "Commands" $< + -n "Commands" < $< > $@ -commands.texi: commands.t - $(BMENU) -p "Getting Started Attaching To The System" \ +$(srcdir)/commands.texi: commands.t + $(BMENU2) -p "Getting Started Attaching To The System" \ -u "Top" \ - -n "Troubleshooting" $< + -n "Troubleshooting" < $< > $@ -trouble.texi: trouble.t - $(BMENU) -p "Commands Thread control" \ +$(srcdir)/trouble.texi: trouble.t + $(BMENU2) -p "Commands Thread control" \ -u "Top" \ - -n "Debug Session Example" $< + -n "Debug Session Example" < $< > $@ -example.texi: example.t - $(BMENU) -p "Troubleshooting Debug server not present" \ +$(srcdir)/example.texi: example.t + $(BMENU2) -p "Troubleshooting Debug server not present" \ -u "Top" \ - -n "" $< + -n "" < $< > $@ EXTRA_DIST = *.t diff --git a/doc/rtems_gdb/rtems_gdb.texi b/doc/rtems_gdb/rtems_gdb.texi index cf527b5232..ef00390330 100644 --- a/doc/rtems_gdb/rtems_gdb.texi +++ b/doc/rtems_gdb/rtems_gdb.texi @@ -19,27 +19,20 @@ @c Master file for the Getting Started (C) Guide @c +@include version.texi @include ../common/setup.texi -@ignore -@ifinfo -@format -START-INFO-DIR-ENTRY -* RTEMS/GDB User's Guide (rtems_gdb): -END-INFO-DIR-ENTRY -@end format -@end ifinfo -@end ignore +@ifset use-ascii +@dircategory RTEMS On-Line Manual +@direntry +* RTEMS/GDB User's Guide: (rtems_gdb). +@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/GDB User's Guide -@subtitle Edition @value{edition}, for @value{version} +@subtitle Edition @value{EDITION}, for @value{VERSION} @sp 1 -@subtitle @value{update-month} +@subtitle @value{UPDATED} @author Emmanuel Raguet and Eric Valette, Canon Research Centre @author On-Line Applications Research Corporation @page diff --git a/doc/rtems_gdb/stamp-vti b/doc/rtems_gdb/stamp-vti new file mode 100644 index 0000000000..27e5ccd0cb --- /dev/null +++ b/doc/rtems_gdb/stamp-vti @@ -0,0 +1,3 @@ +@set UPDATED 1 June 2000 +@set EDITION 1 +@set VERSION 4.5.0-beta3 diff --git a/doc/rtems_gdb/version.texi b/doc/rtems_gdb/version.texi new file mode 100644 index 0000000000..27e5ccd0cb --- /dev/null +++ b/doc/rtems_gdb/version.texi @@ -0,0 +1,3 @@ +@set UPDATED 1 June 2000 +@set EDITION 1 +@set VERSION 4.5.0-beta3 -- cgit v1.2.3