diff options
author | Joachim Nilsson <troglobit@gmail.com> | 2015-04-26 15:06:15 +0200 |
---|---|---|
committer | Joachim Nilsson <troglobit@gmail.com> | 2015-04-26 22:08:33 +0200 |
commit | 3dc3dd161837b314b24e8a9a00718bc1f33aa436 (patch) | |
tree | 3bfc53624f6dc78343ed27c64a1d25a258898c1e /doc/bus_close.3 | |
parent | fix doc (diff) | |
download | bus-3dc3dd161837b314b24e8a9a00718bc1f33aa436.tar.gz bus-3dc3dd161837b314b24e8a9a00718bc1f33aa436.tar.bz2 bus-3dc3dd161837b314b24e8a9a00718bc1f33aa436.tar.xz |
Spell checking and cleanup.
- Fix minor spelling errors.
- Replace empty lines with .PP (new paragraph)
- Replace some underlines with .BR func(section)
- Rephrase from spec. language to standard man page anguage.
- Reflow too long and too short lines to standard < 72 chars.
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
Diffstat (limited to '')
-rw-r--r-- | doc/bus_close.3 | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/bus_close.3 b/doc/bus_close.3 index 94e23a8..025544f 100644 --- a/doc/bus_close.3 +++ b/doc/bus_close.3 @@ -6,9 +6,13 @@ bus_close - Close a bus int bus_close(bus_t *bus); .SH DESCRIPTION -The \fIbus_close\fP function shall dispose of resource require for the process to use a bus whose information is stored in \fIbus\fP. +The +.BR bus_close(3) +function disposes of resources allocated to the process, as referenced +in the \fIbus\fP argument. .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. +Upon successful completion, the function returns 0. Otherwise the +function returns -1 and sets \fIerrno\fP to indicate the error. .SH ERRORS .TP .IR EINVAL @@ -16,9 +20,9 @@ The bus does not exist. .SH SEE ALSO bus-create(1), bus(5), libbus(7), bus_open(3), bus_unlink(3) .SH AUTHORS -See the LICENSE file for the authors. +Principal author, Mattias Andrée. See the LICENSE file for the full +list of authors. .SH LICENSE -See the LICENSE file for the terms of redistribution. +MIT/X Consortium License. .SH BUGS -Please report them. - +Please report bugs to https://github.com/maandree/bus/issues |