summaryrefslogtreecommitdiffstats
path: root/doc/new_chapters/dumpcontrol.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1998-08-25 20:54:47 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1998-08-25 20:54:47 +0000
commitd1a859c0c20ea726ed2f3b2936ff406274bc62a4 (patch)
tree1d9cad10148f0a1296996f0ff7940d60269cae00 /doc/new_chapters/dumpcontrol.t
parentCommit for review (diff)
downloadrtems-d1a859c0c20ea726ed2f3b2936ff406274bc62a4.tar.bz2
Cleaned up formatting.
Added notes on background and operations sections. Added NOTE to indicate the feature flag defined.
Diffstat (limited to 'doc/new_chapters/dumpcontrol.t')
-rw-r--r--doc/new_chapters/dumpcontrol.t39
1 files changed, 20 insertions, 19 deletions
diff --git a/doc/new_chapters/dumpcontrol.t b/doc/new_chapters/dumpcontrol.t
index 677c170a68..5095b8bd1b 100644
--- a/doc/new_chapters/dumpcontrol.t
+++ b/doc/new_chapters/dumpcontrol.t
@@ -10,8 +10,11 @@
@section Introduction
-The
-process dump control manager is ...
+The process dump control manager provides a portable
+interface for changing the path to which a process dump
+is written. The capabilities in this manager were defined in
+the POSIX 1003.1h/D3 proposed standard titled @b{Services for Reliable,
+Available, and Serviceable Systems}.
The directives provided by the process dump control manager are:
@@ -53,16 +56,18 @@ int dump_setpath(
Search permission is denied for a component of the path prefix,
or write permission is denied on the directory containing the
file.
+
@item ENAMETOOLONG
The length of the argument exceeds @code{PATH_MAX} or a pathname
component is longer than @code{NAME_MAX} while @code{_POSIX_NO_TRUNC}
is in effect.
+
@item ENOENT
The path argument points to an empty string.
-@item ENOSYS
-The function dump_setpath() is not suppo9rted by this implementation.
+
@item ENOTDIR
A component of the path prefix is not a directory.
+
@item EROFS
The directory entry specified resides on a read-only file system.
@@ -70,22 +75,18 @@ The directory entry specified resides on a read-only file system.
@subheading DESCRIPTION:
-If @code{_POSIX_DUMP} is defined:
-
- The @code{dump_setpath} function defines the pathname where process
- dumps are written. The pathname pointed to by @code{path} shall
- define where a process dump file will be written if the calling
- process terminates with a dump file. The @code{path} argument
- shall not name a directory.
-
- If the @code{path} argument is NULL, the system shall not write a
- process dump file if the calling process terminates with a dump
- file. If the @code{dump_setpath} function fails, the pathname for
- writing process dumps shall not change.
-
-Otherwise:
+The @code{dump_setpath} function defines the pathname where process
+dumps are written. The pathname pointed to by @code{path} shall
+define where a process dump file will be written if the calling
+process terminates with a dump file. The @code{path} argument
+shall not name a directory.
- The @code{dump_setpath} function shall fail.
+If the @code{path} argument is NULL, the system shall not write a
+process dump file if the calling process terminates with a dump
+file. If the @code{dump_setpath} function fails, the pathname for
+writing process dumps shall not change.
@subheading NOTES:
+The @code{_POSIX_DUMP} feature flag is defined to indicate
+this service is available.