From fb9a80f99d01c616cf2d0d06bd2a0372114ba6f1 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Thu, 26 Mar 1998 17:10:03 +0000 Subject: renamed to user's guide. --- doc/new_chapters/Makefile | 6 +- doc/new_chapters/posix_test_plan.texi | 125 --------------------------------- doc/new_chapters/posix_users.texi | 126 ++++++++++++++++++++++++++++++++++ doc/new_chapters/preface.texi | 9 ++- doc/posix_users/Makefile | 6 +- doc/posix_users/posix_test_plan.texi | 125 --------------------------------- doc/posix_users/posix_users.texi | 126 ++++++++++++++++++++++++++++++++++ doc/posix_users/preface.texi | 9 ++- 8 files changed, 274 insertions(+), 258 deletions(-) delete mode 100644 doc/new_chapters/posix_test_plan.texi create mode 100644 doc/new_chapters/posix_users.texi delete mode 100644 doc/posix_users/posix_test_plan.texi create mode 100644 doc/posix_users/posix_users.texi (limited to 'doc') 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_test_plan.texi deleted file mode 100644 index 2fa481fcac..0000000000 --- a/doc/new_chapters/posix_test_plan.texi +++ /dev/null @@ -1,125 +0,0 @@ -\input ../texinfo/texinfo @c -*-texinfo-*- -@c %**start of header -@setfilename posix_test_plan -@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 C 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 Posix Test Plan: (posix_test_plan). Posix Test Plan -END-INFO-DIR-ENTRY -@end format -@end ifinfo -@end ignore - -@c variable substitution info: -@c -@c @set LANGUAGE C -@c the language is @value{LANGUAGE} -@c NOTE: don't use underscore in the name -@c - -@c -@c Title Page Stuff -@c - -@set edition 970904 -@set version 970904 -@set update-date 4 September 1997 -@set update-month September 1997 -@c -@c I don't really like having a short title page. --joel -@c -@c @shorttitlepage RTEMS POSIX API Test Plan - -@setchapternewpage odd -@settitle RTEMS POSIX API Test Plan -@titlepage -@finalout - -@title RTEMS POSIX API Test Plan -@subtitle Edition @value{edition}, for RTEMS @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 preface.texi -@include thread.texi -@include signal.texi -@include mutex.texi -@include cond.texi -@include key.texi -@include clock.texi -@include sched.texi -@ifinfo -@node Top, Preface, (dir), (dir) -@top posix_test_plan - -This is the online version of the RTEMS POSIX API Test Plan. - -@menu -* Preface:: -* Thread Manager:: -* Signal Manager:: -* Mutex Manager:: -* Condition Variable Manager:: -* Key Manager:: -* Clock Manager:: -* Scheduler Manager:: -* 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, sched_yield, 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 - diff --git a/doc/new_chapters/posix_users.texi b/doc/new_chapters/posix_users.texi new file mode 100644 index 0000000000..7686b2cb40 --- /dev/null +++ b/doc/new_chapters/posix_users.texi @@ -0,0 +1,126 @@ +\input ../texinfo/texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename posix_users +@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 C 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 Posix API User's Guide: (posix_users). Posix API User's Guide Plan +END-INFO-DIR-ENTRY +@end format +@end ifinfo +@end ignore + +@c variable substitution info: +@c +@c @set LANGUAGE C +@c the language is @value{LANGUAGE} +@c NOTE: don't use underscore in the name +@c + +@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 RTEMS POSIX API User's Guide + +@setchapternewpage odd +@settitle RTEMS POSIX API User's Guide +@titlepage +@finalout + +@title RTEMS POSIX API User's Guide +@subtitle Edition @value{edition}, for RTEMS @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 preface.texi +@include thread.texi +@include signal.texi +@include mutex.texi +@include cond.texi +@include key.texi +@include clock.texi +@include sched.texi +@ifinfo +@node Top, Preface, (dir), (dir) +@top posix_users + +This is the online version of the RTEMS POSIX API User's Guide + +@menu +* Preface:: +* Thread Manager:: +* Signal Manager:: +* Mutex Manager:: +* Condition Variable Manager:: +* Key Manager:: +* Clock Manager:: +* Scheduler Manager:: +* 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, sched_yield, 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 + 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_test_plan.texi deleted file mode 100644 index 2fa481fcac..0000000000 --- a/doc/posix_users/posix_test_plan.texi +++ /dev/null @@ -1,125 +0,0 @@ -\input ../texinfo/texinfo @c -*-texinfo-*- -@c %**start of header -@setfilename posix_test_plan -@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 C 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 Posix Test Plan: (posix_test_plan). Posix Test Plan -END-INFO-DIR-ENTRY -@end format -@end ifinfo -@end ignore - -@c variable substitution info: -@c -@c @set LANGUAGE C -@c the language is @value{LANGUAGE} -@c NOTE: don't use underscore in the name -@c - -@c -@c Title Page Stuff -@c - -@set edition 970904 -@set version 970904 -@set update-date 4 September 1997 -@set update-month September 1997 -@c -@c I don't really like having a short title page. --joel -@c -@c @shorttitlepage RTEMS POSIX API Test Plan - -@setchapternewpage odd -@settitle RTEMS POSIX API Test Plan -@titlepage -@finalout - -@title RTEMS POSIX API Test Plan -@subtitle Edition @value{edition}, for RTEMS @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 preface.texi -@include thread.texi -@include signal.texi -@include mutex.texi -@include cond.texi -@include key.texi -@include clock.texi -@include sched.texi -@ifinfo -@node Top, Preface, (dir), (dir) -@top posix_test_plan - -This is the online version of the RTEMS POSIX API Test Plan. - -@menu -* Preface:: -* Thread Manager:: -* Signal Manager:: -* Mutex Manager:: -* Condition Variable Manager:: -* Key Manager:: -* Clock Manager:: -* Scheduler Manager:: -* 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, sched_yield, 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 - diff --git a/doc/posix_users/posix_users.texi b/doc/posix_users/posix_users.texi new file mode 100644 index 0000000000..7686b2cb40 --- /dev/null +++ b/doc/posix_users/posix_users.texi @@ -0,0 +1,126 @@ +\input ../texinfo/texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename posix_users +@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 C 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 Posix API User's Guide: (posix_users). Posix API User's Guide Plan +END-INFO-DIR-ENTRY +@end format +@end ifinfo +@end ignore + +@c variable substitution info: +@c +@c @set LANGUAGE C +@c the language is @value{LANGUAGE} +@c NOTE: don't use underscore in the name +@c + +@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 RTEMS POSIX API User's Guide + +@setchapternewpage odd +@settitle RTEMS POSIX API User's Guide +@titlepage +@finalout + +@title RTEMS POSIX API User's Guide +@subtitle Edition @value{edition}, for RTEMS @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 preface.texi +@include thread.texi +@include signal.texi +@include mutex.texi +@include cond.texi +@include key.texi +@include clock.texi +@include sched.texi +@ifinfo +@node Top, Preface, (dir), (dir) +@top posix_users + +This is the online version of the RTEMS POSIX API User's Guide + +@menu +* Preface:: +* Thread Manager:: +* Signal Manager:: +* Mutex Manager:: +* Condition Variable Manager:: +* Key Manager:: +* Clock Manager:: +* Scheduler Manager:: +* 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, sched_yield, 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 + 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. -- cgit v1.2.3