diff options
| author | Mattias Andrée <maandree@operamail.com> | 2015-04-25 16:35:25 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2015-04-25 16:35:25 +0200 |
| commit | 87b9b381349bb357c937090609ccd6125f051786 (patch) | |
| tree | 03718b99a6bd17d77b8afb89e5708b6cbcef9024 | |
| parent | doc: bus_read: whoops (diff) | |
| download | bus-87b9b381349bb357c937090609ccd6125f051786.tar.gz bus-87b9b381349bb357c937090609ccd6125f051786.tar.bz2 bus-87b9b381349bb357c937090609ccd6125f051786.tar.xz | |
doc: fix formatting
Signed-off-by: Mattias Andrée <maandree@operamail.com>
| -rw-r--r-- | doc/bus_create.3 | 7 | ||||
| -rw-r--r-- | doc/bus_open.3 | 3 | ||||
| -rw-r--r-- | doc/bus_unlink.3 | 3 |
3 files changed, 8 insertions, 5 deletions
diff --git a/doc/bus_create.3 b/doc/bus_create.3 index 68d52cc..b30400e 100644 --- a/doc/bus_create.3 +++ b/doc/bus_create.3 @@ -6,13 +6,13 @@ bus_create - Create a new bus int bus_create(const char *file, int flags, char **out_file); .SH DESCRIPTION -The \fIbus_create\fP function shall create a bus with the asscoiated pathname specifed by the value of the parameter \fIfile\fP. If the \fIfile\iP is \fINULL\fP, a random pathname shall be selected. This random pathname must adhere to the convention set forth by bus(5). +The \fIbus_create\fP function shall create a bus with the asscoiated pathname specifed by the value of the parameter \fIfile\fP. If the \fIfile\fP is \fINULL\fP, a random pathname shall be selected. This random pathname must adhere to the convention set forth by bus(5). If \fIfile\fP is not \fINULL\fP, the \fIbus_create\fP function must fail if the file already exists if \fIflags\fP contains \fIBUS_EXCL\fP. Otherwise if \fIfile\fP is not \fINULL\fP, the \fIbus_create\fP function should do nothing if the file already exists. If and only if \fIflags\fP contains \fIBUS_INTR\fP, the function shall fail if it is interrupted. -Unless \fIout_file\fP is \fINULL\P, the pathname of the bus should be stored in a new char array stored in \fI*out_file\fP. The caller must free the allocated stored in \fI*out_file\fP. +Unless \fIout_file\fP is \fINULL\fP, the pathname of the bus should be stored in a new char array stored in \fI*out_file\fP. The caller must free the allocated stored in \fI*out_file\fP. .SH RETURN VALUES Upon successful completion, the function shall return 0. Otherwise the function shall return -1 and set \fIerrno\fP to indicate the error. .SH ERRORS @@ -20,8 +20,9 @@ Upon successful completion, the function shall return 0. Otherwise the function .IR ENOMEM The process cannot allocate more memory. .SH - +.BR The \fIbus_create\fP() function may also fail and set \fIerrno\fP to any of the errors specified for the rutines open(2) and write(2). +.BR .SH SEE ALSO bus-create(1), bus(5), libbus(7), bus_unlink(3), bus_open(3) .SH AUTHORS diff --git a/doc/bus_open.3 b/doc/bus_open.3 index d193d15..72847d7 100644 --- a/doc/bus_open.3 +++ b/doc/bus_open.3 @@ -31,8 +31,9 @@ Operation permission is denied to the calling process. .IR EINVAL The described bus does not exist. .SH - +.BR The \fIbus_open\fP() function may also fail and set \fIerrno\fP to any of the errors specified for the rutine open(2). +.BR .SH SEE ALSO bus-create(1), bus(5), libbus(7), bus_open(3), bus_unlink(3) .SH AUTHORS diff --git a/doc/bus_unlink.3 b/doc/bus_unlink.3 index ef7cf30..7044922 100644 --- a/doc/bus_unlink.3 +++ b/doc/bus_unlink.3 @@ -20,8 +20,9 @@ Operation permission is denied to the calling process. .IR EPERM The user does not have permission to remove the bus. .SH - +.BR The \fIbus_unlink\fP() function may also fail and set \fIerrno\fP to any of the errors specified for the rutines unlink(2), open(2), semget(3) and shmget(3). +.BR .SH SEE ALSO bus-create(1), bus(5), libbus(7), bus_create(3), bus_close(3) .SH AUTHORS |