docs: minor formatting edits

pull/20/merge
Daniel Stenberg 8 years ago
parent 53952e3022
commit 2e38829571
  1. 15
      ares_cancel.3
  2. 9
      ares_destroy_options.3
  3. 2
      ares_dup.3
  4. 5
      ares_free_string.3

@ -23,14 +23,15 @@ ares_cancel \- Cancel a resolve
.B void ares_cancel(ares_channel \fIchannel\fP) .B void ares_cancel(ares_channel \fIchannel\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fBares_cancel\fP function cancels all lookups/requests made on the the The \fBares_cancel(3)\fP function cancels all lookups/requests made on the the
name service channel identified by \fIchannel\fP. \fBares_cancel\fP invokes name service channel identified by \fIchannel\fP. \fBares_cancel(3)\fP
the callbacks for each pending query on the channel, passing a status of invokes the callbacks for each pending query on the channel, passing a status
of
.BR ARES_ECANCELLED . .BR ARES_ECANCELLED .
These calls give the callbacks a chance to clean up any state which These calls give the callbacks a chance to clean up any state which might have
might have been stored in their arguments. If such a callback invocation adds been stored in their arguments. If such a callback invocation adds a new
a new request to the channel, that request will \fInot\fP be cancelled by the request to the channel, that request will \fInot\fP be cancelled by the
current invocation of \fBares_cancel\fP. current invocation of \fBares_cancel(3)\fP.
.SH SEE ALSO .SH SEE ALSO
.BR ares_init (3) .BR ares_init (3)
.BR ares_destroy (3) .BR ares_destroy (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) .B void ares_destroy_options(struct ares_options *\fIoptions\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The \fBares_destroy_options(3)\fP function destroys the options struct
.B ares_destroy_options identified by \Ioptions\fP, freeing all memory allocated by
function destroys the options struct identified by \fBares_save_options(3)\fP.
.IR options ,
freeing all memory allocated by ares_save_options.
.SH SEE ALSO .SH SEE ALSO
.BR ares_save_options (3), .BR ares_save_options (3),
.BR ares_init_options (3) .BR ares_init_options (3)

@ -33,7 +33,7 @@ handle when the channel is no longer needed.
.BR ares_init(3), .BR ares_init(3),
.BR ares_library_init(3) .BR ares_library_init(3)
.SH AVAILABILITY .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 .SH AUTHOR
Daniel Stenberg Daniel Stenberg

@ -23,9 +23,8 @@ ares_free_string \- Free strings allocated by ares functions
.B void ares_free_string(void *\fIstr\fP) .B void ares_free_string(void *\fIstr\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The \fIares_free_string(3)\fP function frees a string allocated by an ares
.I ares_free_string function.
function frees a string allocated by an ares function.
.SH SEE ALSO .SH SEE ALSO
.BR ares_mkquery (3) .BR ares_mkquery (3)
.BR ares_expand_string (3) .BR ares_expand_string (3)

Loading…
Cancel
Save