source: rtems/doc/new_chapters/dumpcontrol.t @ 571a915

4.104.114.84.95
Last change on this file since 571a915 was 571a915, checked in by Joel Sherrill <joel.sherrill@…>, on 08/25/98 at 22:09:13

Added some background and operations subsections.

  • Property mode set to 100644
File size: 2.3 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-1998.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@chapter Process Dump Control Manager
10
11@section Introduction
12
13The process dump control manager provides a portable
14interface for changing the path to which a process dump
15is written.  The capabilities in this manager were defined in
16the POSIX 1003.1h/D3 proposed standard titled @b{Services for Reliable,
17Available, and Serviceable Systems}.
18
19The directives provided by the process dump control manager are:
20
21@itemize @bullet
22@item @code{dump_setpath} - Dump File Control
23@end itemize
24
25@section Background
26
27There is no background.
28
29@section Operations
30
31There is no discussion of the operations.
32
33@section Directives
34
35This section details the process dump control manager's directives.
36A subsection is dedicated to each of this manager's directives
37and describes the calling sequence, related constants, usage,
38and status codes.
39
40@page
41@subsection dump_setpath - Dump File Control
42
43@subheading CALLING SEQUENCE:
44
45@ifset is-C
46@example
47int dump_setpath(
48  const char      *path
49);
50@end example
51@end ifset
52
53@ifset is-Ada
54@end ifset
55
56@subheading STATUS CODES:
57
58@table @b
59@item EACESS
60Search permission is denied for a component of the path prefix,
61or write permission is denied on the directory containing the
62file.
63
64@item ENAMETOOLONG
65The length of the argument exceeds @code{PATH_MAX} or a pathname
66component is longer than @code{NAME_MAX} while @code{_POSIX_NO_TRUNC}
67is in effect.
68
69@item ENOENT
70The path argument points to an empty string.
71
72@item ENOTDIR
73A component of the path prefix is not a directory.
74
75@item EROFS
76The directory entry specified resides on a read-only file system.
77
78@end table
79
80@subheading DESCRIPTION:
81
82The @code{dump_setpath} function defines the pathname where process
83dumps are written.  The pathname pointed to by @code{path} shall
84define where a process dump file will be written if the calling
85process terminates with a dump file.  The @code{path} argument
86shall not name a directory.
87
88If the @code{path} argument is NULL, the system shall not write a
89process dump file if the calling process terminates with a dump
90file.  If the @code{dump_setpath} function fails, the pathname for
91writing process dumps shall not change.
92
93@subheading NOTES:
94
95The @code{_POSIX_DUMP} feature flag is defined to indicate
96this service is available.
Note: See TracBrowser for help on using the repository browser.