From 2e38829571bf5ca732228c168e020875c8e5319d Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Tue, 27 Sep 2016 12:33:48 +0200 Subject: [PATCH] docs: minor formatting edits --- ares_cancel.3 | 15 ++++++++------- ares_destroy_options.3 | 9 +++------ ares_dup.3 | 2 +- ares_free_string.3 | 5 ++--- 4 files changed, 14 insertions(+), 17 deletions(-) diff --git a/ares_cancel.3 b/ares_cancel.3 index 0bf62810..e534e3f6 100644 --- a/ares_cancel.3 +++ b/ares_cancel.3 @@ -23,14 +23,15 @@ ares_cancel \- Cancel a resolve .B void ares_cancel(ares_channel \fIchannel\fP) .fi .SH DESCRIPTION -The \fBares_cancel\fP function cancels all lookups/requests made on the the -name service channel identified by \fIchannel\fP. \fBares_cancel\fP invokes -the callbacks for each pending query on the channel, passing a status of +The \fBares_cancel(3)\fP function cancels all lookups/requests made on the the +name service channel identified by \fIchannel\fP. \fBares_cancel(3)\fP +invokes the callbacks for each pending query on the channel, passing a status +of .BR ARES_ECANCELLED . -These calls give the callbacks a chance to clean up any state which -might have been stored in their arguments. If such a callback invocation adds -a new request to the channel, that request will \fInot\fP be cancelled by the -current invocation of \fBares_cancel\fP. +These calls give the callbacks a chance to clean up any state which might have +been stored in their arguments. If such a callback invocation adds a new +request to the channel, that request will \fInot\fP be cancelled by the +current invocation of \fBares_cancel(3)\fP. .SH SEE ALSO .BR ares_init (3) .BR ares_destroy (3) diff --git a/ares_destroy_options.3 b/ares_destroy_options.3 index 3e564b2e..31e346b7 100644 --- a/ares_destroy_options.3 +++ b/ares_destroy_options.3 @@ -23,12 +23,9 @@ ares_destroy_options \- Destroy options initialized with ares_save_options .B void ares_destroy_options(struct ares_options *\fIoptions\fP) .fi .SH DESCRIPTION -The -.B ares_destroy_options -function destroys the options struct identified by -.IR options , -freeing all memory allocated by ares_save_options. - +The \fBares_destroy_options(3)\fP function destroys the options struct +identified by \Ioptions\fP, freeing all memory allocated by +\fBares_save_options(3)\fP. .SH SEE ALSO .BR ares_save_options (3), .BR ares_init_options (3) diff --git a/ares_dup.3 b/ares_dup.3 index 87bf2090..e64c1042 100644 --- a/ares_dup.3 +++ b/ares_dup.3 @@ -33,7 +33,7 @@ handle when the channel is no longer needed. .BR ares_init(3), .BR ares_library_init(3) .SH AVAILABILITY -ares_dup(3) was added in c-ares 1.6.0 +\fIares_dup(3)\fP was added in c-ares 1.6.0 .SH AUTHOR Daniel Stenberg diff --git a/ares_free_string.3 b/ares_free_string.3 index 55af7d21..61d88aa2 100644 --- a/ares_free_string.3 +++ b/ares_free_string.3 @@ -23,9 +23,8 @@ ares_free_string \- Free strings allocated by ares functions .B void ares_free_string(void *\fIstr\fP) .fi .SH DESCRIPTION -The -.I ares_free_string -function frees a string allocated by an ares function. +The \fIares_free_string(3)\fP function frees a string allocated by an ares +function. .SH SEE ALSO .BR ares_mkquery (3) .BR ares_expand_string (3)