From e061a0074df0fd1ef5e73691a3b76a41582130c8 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Fri, 28 Aug 1998 13:27:05 +0000 Subject: Added top level file and cleaned up chapter names --- doc/bsp_howto/bsp_howto.texi | 121 +++++++++++++++++++++++++++++++++++++++++++ doc/bsp_howto/bspstruct.t | 2 +- doc/bsp_howto/clock.t | 2 +- doc/bsp_howto/console.t | 2 +- doc/bsp_howto/init.t | 2 +- doc/bsp_howto/linkcmds.t | 2 +- doc/bsp_howto/makefiles.t | 2 +- 7 files changed, 127 insertions(+), 6 deletions(-) create mode 100644 doc/bsp_howto/bsp_howto.texi (limited to 'doc/bsp_howto') diff --git a/doc/bsp_howto/bsp_howto.texi b/doc/bsp_howto/bsp_howto.texi new file mode 100644 index 0000000000..eb3cd1dde2 --- /dev/null +++ b/doc/bsp_howto/bsp_howto.texi @@ -0,0 +1,121 @@ +\input ../texinfo/texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename bsp_howto +@syncodeindex vr fn +@synindex ky cp +@paragraphindent 0 +@c @smallbook +@c %**end of header + +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@c +@c Master file for the Getting Started (C) Guide +@c + +@include ../common/setup.texi + +@c +@c Now set all the tool version dependent information +@c +@include versions.texi + +@ignore +@ifinfo +@format +START-INFO-DIR-ENTRY +* BSP and Device Driver Development Guide (bsp_howto): +END-INFO-DIR-ENTRY +@end format +@end ifinfo +@end ignore + +@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 +@c @shorttitlepage BSP and Device Driver Development Guide + +@setchapternewpage odd +@settitle BSP and Device Driver Development Guide +@titlepage +@finalout + +@title BSP and Device Driver Development Guide +@subtitle Edition @value{edition}, for @value{version} +@sp 1 +@subtitle @value{update-month} +@author On-Line Applications Research Corporation +@page +@include ../common/cpright.texi +@end titlepage + +@c This prevents a black box from being printed on "overflow" lines. +@c The alternative is to rework a sentence to avoid this problem. + +@include intro.texi +@include target.texi +@include bspstruct.texi +@include makefiles.texi +@include linkcmds.texi +@include init.texi +@include clock.texi +@include console.texi +@include timer.texi + +@ifinfo +@node Top, Introduction, (dir), (dir) +@top started + +This is the online version of the Getting Started with RTEMS for C/C++ Users. + +@menu +* Introduction:: +* Target Dependent and Board Dependent Files:: +* Board Support Package Structure:: +* Makefiles:: +* Linkcmds:: +* Initialization Code:: +* Clock Driver:: +* Console Driver:: +* Timer Driver:: +@end menu + +@c * Command and Variable Index:: +@c * Concept Index:: +@end ifinfo +@c +@c +@c Need to copy the emacs stuff and "trailer stuff" (index, toc) into here +@c + +@c @node Command and Variable Index, Concept Index, Installing EGCS AND NEWLIB, Top +@c @unnumbered Command and Variable Index + +@c There are currently no Command and Variable Index entries. + +@c @printindex fn + +@c @node Concept Index, , Command and Variable Index, Top +@c @unnumbered Concept Index + +@c There are currently no Concept Index entries. +@c @printindex cp + +@contents +@bye + diff --git a/doc/bsp_howto/bspstruct.t b/doc/bsp_howto/bspstruct.t index cd42da28e3..8c000618cb 100644 --- a/doc/bsp_howto/bspstruct.t +++ b/doc/bsp_howto/bspstruct.t @@ -1,4 +1,4 @@ -@chapter = The Board Support Package Structure +@chapter = Board Support Package Structure The BSP are all kept in the $RTEMS_ROOT/c/src/lib/libbsp directory. They are filed under the processor family (m68k, powerpc, etc.). A given BSP diff --git a/doc/bsp_howto/clock.t b/doc/bsp_howto/clock.t index 403192fd32..ffb5bfbdd4 100644 --- a/doc/bsp_howto/clock.t +++ b/doc/bsp_howto/clock.t @@ -1,4 +1,4 @@ -@chapter = The Clock Driver +@chapter = Clock Driver @subsection = Introduction diff --git a/doc/bsp_howto/console.t b/doc/bsp_howto/console.t index 9aa3132bc3..776d3fc8ca 100644 --- a/doc/bsp_howto/console.t +++ b/doc/bsp_howto/console.t @@ -1,4 +1,4 @@ -@chapter = The Console Driver +@chapter = Console Driver @subsection = Introduction diff --git a/doc/bsp_howto/init.t b/doc/bsp_howto/init.t index 1da0eec474..63fe397486 100644 --- a/doc/bsp_howto/init.t +++ b/doc/bsp_howto/init.t @@ -1,4 +1,4 @@ -@chapter = The Initialization Code +@chapter = Initialization Code @subsection = Introduction diff --git a/doc/bsp_howto/linkcmds.t b/doc/bsp_howto/linkcmds.t index 62fe323b80..b221dceaa8 100644 --- a/doc/bsp_howto/linkcmds.t +++ b/doc/bsp_howto/linkcmds.t @@ -1,4 +1,4 @@ -@chapter = The Linkcmds +@chapter = Linkcmds @subsection = What is a "linkcmds" file? diff --git a/doc/bsp_howto/makefiles.t b/doc/bsp_howto/makefiles.t index db714b9a04..cd146c3dd0 100644 --- a/doc/bsp_howto/makefiles.t +++ b/doc/bsp_howto/makefiles.t @@ -1,4 +1,4 @@ -@chapter = The Makefiles +@chapter = Makefiles @subsection = Makefiles Used During The BSP Building Process -- cgit v1.2.3