From 6be1dc9d2adbb30ad1df84c74a6ffae042f5ec24 Mon Sep 17 00:00:00 2001
From: Brian Wellington <source@isc.org>
Date: Wed, 21 Feb 2001 18:32:27 +0000
Subject: [PATCH] Document the 'covers' parameter to dns_message_findname and
 dns_message_findtype.

---
 lib/dns/include/dns/message.h | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/lib/dns/include/dns/message.h b/lib/dns/include/dns/message.h
index 1195886248..f1899006a8 100644
--- a/lib/dns/include/dns/message.h
+++ b/lib/dns/include/dns/message.h
@@ -15,7 +15,7 @@
  * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
-/* $Id: message.h,v 1.92 2001/02/14 02:51:09 gson Exp $ */
+/* $Id: message.h,v 1.93 2001/02/21 18:32:27 bwelling Exp $ */
 
 #ifndef DNS_MESSAGE_H
 #define DNS_MESSAGE_H 1
@@ -659,6 +659,9 @@ dns_message_findname(dns_message_t *msg, dns_section_t section,
  *
  *	'type' be a valid type.
  *
+ *	If 'type' is dns_rdatatype_sig, 'covers' must be a valid type.
+ *	Otherwise it should be 0.
+ *
  * Returns:
  *	ISC_R_SUCCESS		-- all is well.
  *	DNS_R_NXDOMAIN		-- name does not exist in that section.
@@ -678,6 +681,9 @@ dns_message_findtype(dns_name_t *name, dns_rdatatype_t type,
  *
  *	'type' be a valid type, and NOT dns_rdatatype_any.
  *
+ *	If 'type' is dns_rdatatype_sig, 'covers' must be a valid type.
+ *	Otherwise it should be 0.
+ *
  * Returns:
  *	ISC_R_SUCCESS		-- all is well.
  *	ISC_R_NOTFOUND		-- the desired type does not exist.