diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2000-06-01 15:29:01 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2000-06-01 15:29:01 +0000 |
commit | fc76a6aa19af9606f260993811ac0dee8ec4e886 (patch) | |
tree | 039d079cce65ec28746118f177fc9bea2e737b11 /doc/porting | |
parent | Patch from Ralf Corsepius <corsepiu@faw.uni-ulm.de>: (diff) | |
download | rtems-fc76a6aa19af9606f260993811ac0dee8ec4e886.tar.bz2 |
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.
Diffstat (limited to 'doc/porting')
-rw-r--r-- | doc/porting/.cvsignore | 1 | ||||
-rw-r--r-- | doc/porting/Makefile.am | 79 | ||||
-rw-r--r-- | doc/porting/porting.texi | 28 | ||||
-rw-r--r-- | doc/porting/stamp-vti | 3 | ||||
-rw-r--r-- | doc/porting/version.texi | 3 |
5 files changed, 60 insertions, 54 deletions
diff --git a/doc/porting/.cvsignore b/doc/porting/.cvsignore index aebe6456c2..d0d16ddf32 100644 --- a/doc/porting/.cvsignore +++ b/doc/porting/.cvsignore @@ -7,6 +7,7 @@ developtools.texi idlethread.texi index.html interrupts.texi +mdate-sh miscellaneous.texi porting porting*.html diff --git a/doc/porting/Makefile.am b/doc/porting/Makefile.am index 7e1cd643e1..f376e5b0b4 100644 --- a/doc/porting/Makefile.am +++ b/doc/porting/Makefile.am @@ -6,73 +6,74 @@ # $Id$ # -AUTOMAKE_OPTIONS = foreign +AUTOMAKE_OPTIONS = foreign 1.4 -PROJECT=porting +PROJECT = porting +EDITION = 1 include $(top_srcdir)/project.am -COMMON_FILES=$(top_srcdir)/common/cpright.texi +FILES = preface.texi developtools.texi sourcecode.texi cpumodels.texi \ + cpuinit.texi interrupts.texi taskcontext.texi idlethread.texi \ + prioritybitmap.texi codetuning.texi miscellaneous.texi -FILES=preface.texi developtools.texi sourcecode.texi cpumodels.texi \ - cpuinit.texi interrupts.texi taskcontext.texi idlethread.texi \ - prioritybitmap.texi codetuning.texi miscellaneous.texi $(COMMON_FILES) +GENERATED_FILES = developtools.texi sourcecode.texi cpumodels.texi \ + cpuinit.texi interrupts.texi taskcontext.texi idlethread.texi \ + prioritybitmap.texi codetuning.texi miscellaneous.texi -GENERATED_FILES=developtools.texi sourcecode.texi cpumodels.texi \ - cpuinit.texi interrupts.texi taskcontext.texi idlethread.texi \ - prioritybitmap.texi codetuning.texi miscellaneous.texi +COMMON_FILES = $(top_srcdir)/common/setup.texi $(top_srcdir)/common/cpright.texi info_TEXINFOS = porting.texi porting_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) -developtools.texi: developtools.t - $(BMENU) -p "Preface" \ +$(srcdir)/developtools.texi: developtools.t + $(BMENU2) -p "Preface" \ -u "Top" \ - -n "Source Code Organization" $< + -n "Source Code Organization" < $< > $@ -sourcecode.texi: sourcecode.t - $(BMENU) -p "Development Tools" \ +$(srcdir)/sourcecode.texi: sourcecode.t + $(BMENU2) -p "Development Tools" \ -u "Top" \ - -n "CPU Model Variations" $< + -n "CPU Model Variations" < $< > $@ -cpumodels.texi: cpumodels.t - $(BMENU) -p "Source Code Organization Introduction" \ +$(srcdir)/cpumodels.texi: cpumodels.t + $(BMENU2) -p "Source Code Organization Introduction" \ -u "Top" \ - -n "CPU Initialization" $< + -n "CPU Initialization" < $< > $@ -cpuinit.texi: cpuinit.t - $(BMENU) -p "CPU Model Variations Coding Issues" \ +$(srcdir)/cpuinit.texi: cpuinit.t + $(BMENU2) -p "CPU Model Variations Coding Issues" \ -u "Top" \ - -n "Interrupts" $< + -n "Interrupts" < $< > $@ -interrupts.texi: interrupts.t - $(BMENU) -p "CPU Initialization Initializing the CPU" \ +$(srcdir)/interrupts.texi: interrupts.t + $(BMENU2) -p "CPU Initialization Initializing the CPU" \ -u "Top" \ - -n "Task Context Management" $< + -n "Task Context Management" < $< > $@ -taskcontext.texi: taskcontext.t - $(BMENU) -p "Interrupts Pointer to _Thread_Dispatch Routine" \ +$(srcdir)/taskcontext.texi: taskcontext.t + $(BMENU2) -p "Interrupts Pointer to _Thread_Dispatch Routine" \ -u "Top" \ - -n "IDLE Thread" $< + -n "IDLE Thread" < $< > $@ -idlethread.texi: idlethread.t - $(BMENU) -p "Task Context Management Restoring a Floating Point Context" \ +$(srcdir)/idlethread.texi: idlethread.t + $(BMENU2) -p "Task Context Management Restoring a Floating Point Context" \ -u "Top" \ - -n "Priority Bitmap Manipulation" $< + -n "Priority Bitmap Manipulation" < $< > $@ -prioritybitmap.texi: prioritybitmap.t - $(BMENU) -p "IDLE Thread Idle Thread Body" \ +$(srcdir)/prioritybitmap.texi: prioritybitmap.t + $(BMENU2) -p "IDLE Thread Idle Thread Body" \ -u "Top" \ - -n "Code Tuning Parameters" $< + -n "Code Tuning Parameters" < $< > $@ -codetuning.texi: codetuning.t - $(BMENU) -p "Priority Bitmap Manipulation Bit Scan Support" \ +$(srcdir)/codetuning.texi: codetuning.t + $(BMENU2) -p "Priority Bitmap Manipulation Bit Scan Support" \ -u "Top" \ - -n "Miscellaneous" $< + -n "Miscellaneous" < $< > $@ -miscellaneous.texi: miscellaneous.t - $(BMENU) -p "Code Tuning Parameters Partition Element Alignment" \ +$(srcdir)/miscellaneous.texi: miscellaneous.t + $(BMENU2) -p "Code Tuning Parameters Partition Element Alignment" \ -u "Top" \ - -n "Command and Variable Index" $< + -n "Command and Variable Index" < $< > $@ EXTRA_DIST = *.t diff --git a/doc/porting/porting.texi b/doc/porting/porting.texi index 13969006a7..1052097b53 100644 --- a/doc/porting/porting.texi +++ b/doc/porting/porting.texi @@ -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 Porting Guide: (porting). The Porting Guide -END-INFO-DIR-ENTRY -@end format -@end ifinfo -@end ignore +@ifset use-ascii +@dircategory RTEMS On-Line Manual +@direntry +* RTEMS Porting Guide: (porting). The Porting Guide +@end direntry +@end ifset @c variable substitution info: @c @@ -55,10 +53,10 @@ 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 @@ -71,9 +69,9 @@ END-INFO-DIR-ENTRY @finalout @title RTEMS Porting 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 diff --git a/doc/porting/stamp-vti b/doc/porting/stamp-vti new file mode 100644 index 0000000000..27e5ccd0cb --- /dev/null +++ b/doc/porting/stamp-vti @@ -0,0 +1,3 @@ +@set UPDATED 1 June 2000 +@set EDITION 1 +@set VERSION 4.5.0-beta3 diff --git a/doc/porting/version.texi b/doc/porting/version.texi new file mode 100644 index 0000000000..27e5ccd0cb --- /dev/null +++ b/doc/porting/version.texi @@ -0,0 +1,3 @@ +@set UPDATED 1 June 2000 +@set EDITION 1 +@set VERSION 4.5.0-beta3 |