Documentation: properly document ARES_ECANCELLED

This commit clarifies the behaviour of ares_cancel() with respect to
callbacks and adds missing documentation of ARES_ECANCELLED to the man
pages of the affected functions.

diff --git a/ares_cancel.3 b/ares_cancel.3
index ef10ec587a23aa3bad56ee5b730b9db1a1d1e936..0bf62810069ef9889fa5777da0b79350ff89c94f 100644 (file)
--- a/ares_cancel.3
+++ b/ares_cancel.3
@@ -28,7 +28,9 @@ name service channel identified by \fIchannel\fP.  \fBares_cancel\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.
+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.
 .SH SEE ALSO
 .BR ares_init (3)
 .BR ares_destroy (3)

diff --git a/ares_gethostbyaddr.3 b/ares_gethostbyaddr.3
index f5898682945fe0a9e326c7b7d6347abddc2b70ef..77273075566f10149fb164f85c3436d1f4efea90 100644 (file)
--- a/ares_gethostbyaddr.3
+++ b/ares_gethostbyaddr.3
@@ -70,6 +70,9 @@ was not found.
 .B ARES_ENOMEM
 Memory was exhausted.
 .TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
 .B ARES_EDESTRUCTION
 The name service channel
 .I channel

diff --git a/ares_gethostbyname.3 b/ares_gethostbyname.3
index a578a53219ca52d417e630aa87b47f66cf617bc2..6b24ea4d2d9a5e44c45f161c2a5e45f96a02d0cb 100644 (file)
--- a/ares_gethostbyname.3
+++ b/ares_gethostbyname.3
@@ -74,6 +74,9 @@ was not found.
 .B ARES_ENOMEM
 Memory was exhausted.
 .TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
 .B ARES_EDESTRUCTION
 The name service channel
 .I channel

diff --git a/ares_getnameinfo.3 b/ares_getnameinfo.3
index 7e4990c3eab3a2ce3c8787c91f079350735a1298..d227606eab1901597493232a27afc42fad75cf77 100644 (file)
--- a/ares_getnameinfo.3
+++ b/ares_getnameinfo.3
@@ -109,6 +109,9 @@ was not found.
 .B ARES_ENOMEM
 Memory was exhausted.
 .TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
 .B ARES_EDESTRUCTION
 The name service channel
 .I channel

diff --git a/ares_query.3 b/ares_query.3
index 0c5df844c8b26fe53eaf0d9a767a75d490ad3a99..733fbc972b58faa90c6d0385b45830a21b084064 100644 (file)
--- a/ares_query.3
+++ b/ares_query.3
@@ -118,6 +118,9 @@ No name servers could be contacted.
 .B ARES_ENOMEM
 Memory was exhausted.
 .TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
 .B ARES_EDESTRUCTION
 The name service channel
 .I channel

diff --git a/ares_search.3 b/ares_search.3
index 4184b00673d2e9cbcd7210a319f640816fdf5272..2c85d20f645b08cb07a2282d1798925d51fef11b 100644 (file)
--- a/ares_search.3
+++ b/ares_search.3
@@ -119,6 +119,9 @@ No name servers could be contacted.
 .B ARES_ENOMEM
 Memory was exhausted.
 .TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
 .B ARES_EDESTRUCTION
 The name service channel
 .I channel

diff --git a/ares_send.3 b/ares_send.3
index 48d90abc1073dc45e7ea99b9d7ccaaa905ca60f3..b89abfeb85a8909f89703438224edab0d398e156 100644 (file)
--- a/ares_send.3
+++ b/ares_send.3
@@ -73,6 +73,9 @@ No name servers could be contacted.
 .B ARES_ENOMEM
 Memory was exhausted.
 .TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
 .B ARES_EDESTRUCTION
 The name service channel
 .I channel