summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1998-03-26 17:10:03 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1998-03-26 17:10:03 +0000
commitfb9a80f99d01c616cf2d0d06bd2a0372114ba6f1 (patch)
tree88f1e1f9dbed5844a83031e15055a012e690f701 /doc
parentHAS_CPLUSPLUS should have been RTEMS_HAS_CPLUSPLUS. (diff)
downloadrtems-fb9a80f99d01c616cf2d0d06bd2a0372114ba6f1.tar.bz2
renamed to user's guide.
Diffstat (limited to 'doc')
-rw-r--r--doc/new_chapters/Makefile6
-rw-r--r--doc/new_chapters/posix_users.texi (renamed from doc/new_chapters/posix_test_plan.texi)23
-rw-r--r--doc/new_chapters/preface.texi9
-rw-r--r--doc/posix_users/Makefile6
-rw-r--r--doc/posix_users/posix_users.texi (renamed from doc/posix_users/posix_test_plan.texi)23
-rw-r--r--doc/posix_users/preface.texi9
6 files changed, 46 insertions, 30 deletions
diff --git a/doc/new_chapters/Makefile b/doc/new_chapters/Makefile
index a177dc1ccd..0364894488 100644
--- a/doc/new_chapters/Makefile
+++ b/doc/new_chapters/Makefile
@@ -8,7 +8,7 @@
include ../Make.config
-PROJECT=posix_test_plan
+PROJECT=posix_users
all:
@@ -24,7 +24,7 @@ info: $(PROJECT)
# cp $(PROJECT) $(PROJECT)-* $(INFO_INSTALL)
cp $(PROJECT) $(INFO_INSTALL)
-posix_test_plan: $(FILES)
+posix_users: $(FILES)
$(MAKEINFO) $(PROJECT).texi
vinfo: info
@@ -48,9 +48,9 @@ $(PROJECT).dvi: $(FILES)
html:
-mkdir $(WWW_INSTALL)/$(PROJECT)
+ -cd .. ; gmake headers
$(TEXI2WWW) $(TEXI2WWW_ARGS) -dir $(WWW_INSTALL)/$(PROJECT) \
$(PROJECT).texi
- cp ../rtems.html $(WWW_INSTALL)
clean:
diff --git a/doc/new_chapters/posix_test_plan.texi b/doc/new_chapters/posix_users.texi
index 2fa481fcac..7686b2cb40 100644
--- a/doc/new_chapters/posix_test_plan.texi
+++ b/doc/new_chapters/posix_users.texi
@@ -1,6 +1,6 @@
\input ../texinfo/texinfo @c -*-texinfo-*-
@c %**start of header
-@setfilename posix_test_plan
+@setfilename posix_users
@syncodeindex vr fn
@synindex ky cp
@paragraphindent 0
@@ -31,7 +31,7 @@
@ifinfo
@format
START-INFO-DIR-ENTRY
-* RTEMS Posix Test Plan: (posix_test_plan). Posix Test Plan
+* RTEMS Posix API User's Guide: (posix_users). Posix API User's Guide Plan
END-INFO-DIR-ENTRY
@end format
@end ifinfo
@@ -48,21 +48,22 @@ END-INFO-DIR-ENTRY
@c Title Page Stuff
@c
-@set edition 970904
-@set version 970904
-@set update-date 4 September 1997
-@set update-month September 1997
+@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 RTEMS POSIX API Test Plan
+@c @shorttitlepage RTEMS POSIX API User's Guide
@setchapternewpage odd
-@settitle RTEMS POSIX API Test Plan
+@settitle RTEMS POSIX API User's Guide
@titlepage
@finalout
-@title RTEMS POSIX API Test Plan
+@title RTEMS POSIX API User's Guide
@subtitle Edition @value{edition}, for RTEMS @value{version}
@sp 1
@subtitle @value{update-month}
@@ -84,9 +85,9 @@ END-INFO-DIR-ENTRY
@include sched.texi
@ifinfo
@node Top, Preface, (dir), (dir)
-@top posix_test_plan
+@top posix_users
-This is the online version of the RTEMS POSIX API Test Plan.
+This is the online version of the RTEMS POSIX API User's Guide
@menu
* Preface::
diff --git a/doc/new_chapters/preface.texi b/doc/new_chapters/preface.texi
index fd7099c46e..660819a77c 100644
--- a/doc/new_chapters/preface.texi
+++ b/doc/new_chapters/preface.texi
@@ -11,4 +11,11 @@
@end ifinfo
@unnumbered Preface
-This is the test plan document for the POSIX API support for RTEMS.
+This is the user's guide for the POSIX API support for RTEMS.
+
+At this point, this is just a basic shell of what this manual
+should ultimately be.
+
+Much of the POSIX API standard is actually implemented in the
+newlib ANSI C Library. Please refer to documentation on
+newlib for more information on what it supplies.
diff --git a/doc/posix_users/Makefile b/doc/posix_users/Makefile
index a177dc1ccd..0364894488 100644
--- a/doc/posix_users/Makefile
+++ b/doc/posix_users/Makefile
@@ -8,7 +8,7 @@
include ../Make.config
-PROJECT=posix_test_plan
+PROJECT=posix_users
all:
@@ -24,7 +24,7 @@ info: $(PROJECT)
# cp $(PROJECT) $(PROJECT)-* $(INFO_INSTALL)
cp $(PROJECT) $(INFO_INSTALL)
-posix_test_plan: $(FILES)
+posix_users: $(FILES)
$(MAKEINFO) $(PROJECT).texi
vinfo: info
@@ -48,9 +48,9 @@ $(PROJECT).dvi: $(FILES)
html:
-mkdir $(WWW_INSTALL)/$(PROJECT)
+ -cd .. ; gmake headers
$(TEXI2WWW) $(TEXI2WWW_ARGS) -dir $(WWW_INSTALL)/$(PROJECT) \
$(PROJECT).texi
- cp ../rtems.html $(WWW_INSTALL)
clean:
diff --git a/doc/posix_users/posix_test_plan.texi b/doc/posix_users/posix_users.texi
index 2fa481fcac..7686b2cb40 100644
--- a/doc/posix_users/posix_test_plan.texi
+++ b/doc/posix_users/posix_users.texi
@@ -1,6 +1,6 @@
\input ../texinfo/texinfo @c -*-texinfo-*-
@c %**start of header
-@setfilename posix_test_plan
+@setfilename posix_users
@syncodeindex vr fn
@synindex ky cp
@paragraphindent 0
@@ -31,7 +31,7 @@
@ifinfo
@format
START-INFO-DIR-ENTRY
-* RTEMS Posix Test Plan: (posix_test_plan). Posix Test Plan
+* RTEMS Posix API User's Guide: (posix_users). Posix API User's Guide Plan
END-INFO-DIR-ENTRY
@end format
@end ifinfo
@@ -48,21 +48,22 @@ END-INFO-DIR-ENTRY
@c Title Page Stuff
@c
-@set edition 970904
-@set version 970904
-@set update-date 4 September 1997
-@set update-month September 1997
+@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 RTEMS POSIX API Test Plan
+@c @shorttitlepage RTEMS POSIX API User's Guide
@setchapternewpage odd
-@settitle RTEMS POSIX API Test Plan
+@settitle RTEMS POSIX API User's Guide
@titlepage
@finalout
-@title RTEMS POSIX API Test Plan
+@title RTEMS POSIX API User's Guide
@subtitle Edition @value{edition}, for RTEMS @value{version}
@sp 1
@subtitle @value{update-month}
@@ -84,9 +85,9 @@ END-INFO-DIR-ENTRY
@include sched.texi
@ifinfo
@node Top, Preface, (dir), (dir)
-@top posix_test_plan
+@top posix_users
-This is the online version of the RTEMS POSIX API Test Plan.
+This is the online version of the RTEMS POSIX API User's Guide
@menu
* Preface::
diff --git a/doc/posix_users/preface.texi b/doc/posix_users/preface.texi
index fd7099c46e..660819a77c 100644
--- a/doc/posix_users/preface.texi
+++ b/doc/posix_users/preface.texi
@@ -11,4 +11,11 @@
@end ifinfo
@unnumbered Preface
-This is the test plan document for the POSIX API support for RTEMS.
+This is the user's guide for the POSIX API support for RTEMS.
+
+At this point, this is just a basic shell of what this manual
+should ultimately be.
+
+Much of the POSIX API standard is actually implemented in the
+newlib ANSI C Library. Please refer to documentation on
+newlib for more information on what it supplies.