first cut at adding an Ada bindings manual

1997-05-29 21:53:39 +00:00
parent 00d2a82897
commit 3a8256db27
3 changed files with 228 additions and 1 deletions
--- a/doc/ada_user/Makefile
+++ b/doc/ada_user/Makefile
@@ -0,0 +1,64 @@
+#
+#  COPYRIGHT (c) 1996.
+#  On-Line Applications Research Corporation (OAR).
+#  All rights reserved.
+#
+
+include ../Make.config
+
+PROJECT=ada_user
+
+all:  
+
+COMMON_FILES=../common/cpright.texi ../user/bsp.texi ../user/clock.texi \
+  ../user/concepts.texi ../user/conf.texi ../user/dirstat.texi \
+  ../user/dpmem.texi ../user/event.texi ../user/example.texi \
+  ../user/fatal.texi ../user/glossary.texi ../user/init.texi \
+  ../user/intr.texi ../user/io.texi ../user/mp.texi ../user/msg.texi \
+  ../user/overview.texi ../user/part.texi ../user/preface.texi \
+  ../user/region.texi ../user/rtmon.texi ../user/schedule.texi \
+  ../user/sem.texi ../user/signal.texi ../user/task.texi \
+  ../user/timer.texi ../user/userext.texi 
+FILES= ada_user.texi $(COMMON_FILES)
+
+all:
+
+INFOFILES=$(wildcard $(PROJECT) $(PROJECT)-*)
+
+info: ada_user
+	cp $(PROJECT) $(PROJECT)-* $(INFO_INSTALL)
+
+ada_user: $(FILES)
+	$(MAKEINFO) $(PROJECT).texi
+
+vinfo: info
+	$(INFO) -f $(PROJECT)
+
+dvi: $(PROJECT).dvi
+ps: $(PROJECT).ps
+	
+$(PROJECT).ps: $(PROJECT).dvi
+	dvips -o $(PROJECT).ps $(PROJECT).dvi
+	cp $(PROJECT).ps $(PS_INSTALL)
+
+dv: dvi
+	$(XDVI) $(PROJECT).dvi
+
+view: ps
+	$(GHOSTVIEW) $(PROJECT).ps
+
+$(PROJECT).dvi: $(FILES)
+	$(TEXI2DVI) $(PROJECT).texi
+
+html:
+	-mkdir $(WWW_INSTALL)/ada_user
+	cp ../user/rtemsarc.gif ../user/rtemspie.gif ../user/states.gif \
+           $(WWW_INSTALL)/ada_user
+	$(TEXI2WWW) $(TEXI2WWW_ARGS) -dir $(WWW_INSTALL)/$(PROJECT) \
+ 	    $(PROJECT).texi
+
+clean:
+	rm -f *.o $(PROG) *.txt core *.html 
+	rm -f *.dvi *.ps *.log *.aux *.cp *.fn *.ky *.pg *.toc *.tp *.vr $(BASE)
+	rm -f ada_user ada_user-* _*
+
--- a/doc/ada_user/ada_user.texi
+++ b/doc/ada_user/ada_user.texi
@@ -0,0 +1,163 @@
+\input ../texinfo/texinfo   @c -*-texinfo-*-
+@c %**start of header
+@setfilename ada_user
+@syncodeindex vr fn
+@synindex ky cp
+@paragraphindent 0
+@c @smallbook
+@c %**end of header
+
+@c
+@c  COPYRIGHT (c) 1988-1996.
+@c  On-Line Applications Research Corporation (OAR).
+@c  All rights reserved.
+@c
+
+@c
+@c   Master file for the Ada User's Guide
+@c
+
+@c Joel's Questions
+@c
+@c  1.  Why does paragraphindent only impact makeinfo?
+@c  2.  Why does paragraphindent show up in HTML?
+@c
+
+@include ../common/setup.texi
+
+@ignore
+@ifinfo
+@format
+START-INFO-DIR-ENTRY
+* RTEMS Ada User: (ada_user).             The Ada User's Guide
+END-INFO-DIR-ENTRY
+@end format
+@end ifinfo
+@end ignore
+
+@c variable substitution info:
+@c
+@clear is-C
+@set is-Ada
+@set RTEMS-LANGUAGE Ada
+@set RTEMS-STRUCTURE record
+@set RTEMS-ROUTINE subprogram
+@c the language is @value{RTEMS-LANGUAGE}
+@c NOTE:  don't use underscore in the name
+@c
+
+@c
+@c  Title Page Stuff
+@c
+
+@set edition 4.1.0a
+@set update-date 1 June 97
+@set update-month June 97
+
+@c
+@c  I don't really like having a short title page.  --joel
+@c
+@c @shorttitlepage RTEMS Applications Ada User's Guide
+
+@setchapternewpage odd
+@settitle RTEMS Ada User's Guide
+@titlepage
+@finalout
+
+@title RTEMS Applications Ada User's Guide
+@subtitle Edition @value{edition}, for RTEMS 4.1.0
+@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 ../user/preface.texi
+@include ../user/overview.texi
+@include ../user/concepts.texi
+@include ../user/init.texi
+@include ../user/task.texi
+@include ../user/intr.texi
+@include ../user/clock.texi
+@include ../user/timer.texi
+@include ../user/sem.texi
+@include ../user/msg.texi
+@include ../user/event.texi
+@include ../user/signal.texi
+@include ../user/part.texi
+@include ../user/region.texi
+@include ../user/dpmem.texi
+@include ../user/io.texi
+@include ../user/fatal.texi
+@include ../user/schedule.texi
+@include ../user/rtmon.texi
+@include ../user/bsp.texi
+@include ../user/userext.texi
+@include ../user/conf.texi
+@include ../user/mp.texi
+@include ../user/dirstat.texi
+@include ../user/example.texi
+@include ../user/glossary.texi
+@ifinfo
+@node Top, Preface, (dir), (dir)
+@top ada_user
+
+This is the online version of the RTEMS Ada User's Guide.
+
+@menu
+* Preface::
+* Overview::
+* Key Concepts::
+* Initialization Manager::
+* Task Manager::
+* Interrupt Manager::
+* Clock Manager::
+* Timer Manager::
+* Semaphore Manager::
+* Message Manager::
+* Event Manager::
+* Signal Manager::
+* Partition Manager::
+* Region Manager::
+* Dual-Ported Memory Manager::
+* I/O Manager::
+* Fatal Error Manager::
+* Scheduling Concepts::
+* Rate Monotonic Manager::
+* Board Support Packages::
+* User Extensions Manager::
+* Configuring a System::
+* Multiprocessing Manager::
+* Directive Status Codes::
+* Example Application::
+* Glossary::
+* Command and Variable Index::
+* Concept Index::
+@end menu
+
+@end ifinfo
+@c 
+@c 
+@c Need to copy the emacs stuff and "trailer stuff" (index, toc) into here
+@c
+
+@node Command and Variable Index, Concept Index, Glossary, Top
+@unnumbered Command and Variable Index
+
+There are currently no Command and Variable Index entries.
+
+@c @printindex fn
+
+@node Concept Index, , Command and Variable Index, Top
+@unnumbered Concept Index
+
+There are currently no Concept Index entries.
+@c @printindex cp
+
+@contents
+@bye
+
--- a/doc/do_docs
+++ b/doc/do_docs
@@ -2,7 +2,7 @@

 basedir=$1
 shift
-manuals="develenv hppa1_1 i386 i960 m68k relnotes sparc user ka9q"
+manuals="develenv hppa1_1 i386 i960 m68k relnotes sparc c_user ka9q"
 # posix_test_plan manual left out in 4.1.0

 for action in $*