From bc950e878a06243e272493eff8a9509b4e416483 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Thu, 19 Nov 1998 16:02:06 +0000 Subject: Applied updates from remote work while doing class. --- doc/new_chapters/Makefile | 28 ++++++++- doc/new_chapters/files.t | 129 ++++++++++++++++++++++++++++++++++++++ doc/new_chapters/gen_section | 26 ++++++++ doc/new_chapters/posix_users.texi | 10 +++ doc/new_chapters/signal.t | 2 + 5 files changed, 193 insertions(+), 2 deletions(-) (limited to 'doc/new_chapters') diff --git a/doc/new_chapters/Makefile b/doc/new_chapters/Makefile index 90d078621d..b84f9ea840 100644 --- a/doc/new_chapters/Makefile +++ b/doc/new_chapters/Makefile @@ -23,7 +23,8 @@ GENERATED_FILES= \ cspecific.texi device.texi dumpcontrol.texi eventlog.texi files.texi \ io.texi key.texi memorymgmt.texi message.texi mutex.texi procenv.texi \ process.texi sched.texi semaphores.texi signal.texi systemdb.texi \ - thread.texi + thread.texi \ + stackchk.texi rtmonuse.texi cpuuse.texi error.texi monitor.texi FILES= posix_users.texi preface.texi \ $(COMMON_FILES) $(GENERATED_FILES) @@ -54,7 +55,6 @@ html: dirs $(FILES) $(TEXI2WWW) $(TEXI2WWW_ARGS) -dir $(WWW_INSTALL)/$(PROJECT) \ posix_users.texi - clean: rm -f *.o $(PROG) *.txt core *.html rm -f *.dvi *.ps *.log *.aux *.cp *.fn *.ky *.pg *.toc *.tp *.vr $(BASE) @@ -170,3 +170,27 @@ systemdb.texi: systemdb.t Makefile -u "Top" \ -n "" ${*}.t +stackchk.texi: stackchk.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +rtmonuse.texi: rtmonuse.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +cpuuse.texi: cpuuse.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +error.texi: error.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +monitor.texi: monitor.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t diff --git a/doc/new_chapters/files.t b/doc/new_chapters/files.t index 121c70c6c1..1a116cc3fa 100644 --- a/doc/new_chapters/files.t +++ b/doc/new_chapters/files.t @@ -28,6 +28,8 @@ The directives provided by the files and directories manager are: @item @code{creat} - Create a new file or rewrite an existing one @item @code{umask} - Sets a file creation mask @item @code{link} - Creates a link to a file +@item @code{symlink} - Creates a symbolic link to a file +@item @code{readlink} - Obtain the name of the link destination @item @code{mkdir} - Makes a directory @item @code{mkfifo} - Makes a FIFO special file @item @code{unlink} - Removes a directory entry @@ -740,6 +742,133 @@ The caller may (or may not) need permission to access the existing file. NONE +@page +@subsection symlink - Creates a symbolic link to a file + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +#include + +int symlink( + const char *topath, + const char *frompath +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@table @b + +@item EACCES +Search permission is denied for a directory in a file's path prefix + +@item EEXIST +The named file already exists. + +@item ENAMETOOLONG +Length of a filename string exceeds PATH_MAX and _POSIX_NO_TRUNC is in +effect. + +@item ENOENT +A file or directory does not exist. + +@item ENOSPC +No space left on disk. + +@item ENOTDIR +A component of the specified pathname was not a directory when a directory +was expected. + +@item EPERM +Operation is not permitted. Process does not have the appropriate priviledges +or permissions to perform the requested operations. + +@item EROFS +Read-only file system. + +@end table + +@subheading DESCRIPTION: + +The @code{symlink()} function creates a symbolic link from the frombath to the +topath. The symbolic link will be interpreted at run-time. + +If the @code{symlink()} function fails, no directories are modified. + +The caller may (or may not) need permission to access the existing file. + +@subheading NOTES: + +NONE + +@page +@subsection readlink - Obtain the name of a symbolic link destination + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +#include + +int readlink( + const char *path, + char *buf, + size_t bufsize +); + +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@table @b + +@item EACCES +Search permission is denied for a directory in a file's path prefix + +@item ENAMETOOLONG +Length of a filename string exceeds PATH_MAX and _POSIX_NO_TRUNC is in +effect. + +@item ENOENT +A file or directory does not exist. + +@item ENOTDIR +A component of the prefix pathname was not a directory when a directory +was expected. + +@item ELOOP +Too many symbolic links were encountered in the pathname. + +@item EINVAL +The pathname does not refer to a symbolic link + +@item EFAULT +An invalid pointer was passed into the @code{readlink()} routine. + +@end table + +@subheading DESCRIPTION: + +The @code{readlink()} function places the symbolic link destination into +@code{buf} argument and returns the number of characters copied. + +If the symbolic link destination is longer than bufsize characters the +name will be truncated. + +@subheading NOTES: + +NONE + @page @subsection mkdir - Makes a directory diff --git a/doc/new_chapters/gen_section b/doc/new_chapters/gen_section index d3b8bde58f..d07769455a 100644 --- a/doc/new_chapters/gen_section +++ b/doc/new_chapters/gen_section @@ -129,6 +129,32 @@ case ${chapter} in ROUTINES="strcpy strncpy strcat strncat strcmp strncmp strchr strcspn \ strpbrk strrchr strspn strstr strtok stlen" ;; + misc_stackchk) + CHAPTER_CAPS="Stack Bounds Checker" + CHAPTER_LOWER="stack bounds checker" + ROUTINES="Stack_check_Initialize Stack_check_Dump_usage" + ;; + misc_rtmonuse) + CHAPTER_CAPS="Rate Monotonic Period Statistics" + CHAPTER_LOWER="rate monotonic period statistics" + ROUTINES="Period_usage_Initialize Period_usage_Reset \ + Period_usage_Update Period_usage_Dump" + ;; + misc_cpuuse) + CHAPTER_CAPS="CPU Usage Statistics" + CHAPTER_LOWER="CPU usage statistics" + ROUTINES="CPU_usage_Dump CPU_usage_Reset" + ;; + misc_error) + CHAPTER_CAPS="Error Reporting Support" + CHAPTER_LOWER="error reporting support" + ROUTINES="rtems_error rtems_panic" + ;; + misc_monitor) + CHAPTER_CAPS="Monitor Task" + CHAPTER_LOWER="monitor task" + ROUTINES="rtems_monitor_init rtems_monitor_wakeup" + ;; *) echo "Unknown chapter name" exit 1 diff --git a/doc/new_chapters/posix_users.texi b/doc/new_chapters/posix_users.texi index 3fe66ed75c..36627225ae 100644 --- a/doc/new_chapters/posix_users.texi +++ b/doc/new_chapters/posix_users.texi @@ -107,6 +107,11 @@ END-INFO-DIR-ENTRY @include dumpcontrol.texi @include confspace.texi @include adminiface.texi +@include stackchk.texi +@include rtmonuse.texi +@include cpuuse.texi +@include error.texi +@include monitor.texi @ifinfo @node Top, Preface, (dir), (dir) @top posix_users_new @@ -137,6 +142,11 @@ This is the online version of the RTEMS POSIX API User's Guide * Process Dump Control Manager:: * Configuration Space Manager:: * Administration Interface Manager:: +* Stack Bounds Checker:: +* Rate Monotonic Period Statistics:: +* CPU Usage Statistics:: +* Error Reporting Support:: +* Monitor Task:: * Command and Variable Index:: * Concept Index:: @end menu diff --git a/doc/new_chapters/signal.t b/doc/new_chapters/signal.t index 38e096c403..f37708bd4a 100644 --- a/doc/new_chapters/signal.t +++ b/doc/new_chapters/signal.t @@ -108,6 +108,8 @@ This function adds the @code{signo} to the specified signal @code{set}. @subheading NOTES: +NONE + @page @subsection sigdelset - Delete a Signal from a Signal Set -- cgit v1.2.3