From rfg@monkeys.com  Thu Apr  3 11:49:02 2003
Return-Path: <rfg@monkeys.com>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 7B5D537B404
	for <FreeBSD-gnats-submit@freebsd.org>; Thu,  3 Apr 2003 11:49:02 -0800 (PST)
Received: from segfault.monkeys.com (segfault.monkeys.com [66.60.157.246])
	by mx1.FreeBSD.org (Postfix) with ESMTP id EA63843F75
	for <FreeBSD-gnats-submit@freebsd.org>; Thu,  3 Apr 2003 11:49:01 -0800 (PST)
	(envelope-from rfg@monkeys.com)
Received: by segfault.monkeys.com (Postfix, from userid 1237)
	id 7357741F9C; Thu,  3 Apr 2003 11:49:01 -0800 (PST)
Message-Id: <20030403194901.7357741F9C@segfault.monkeys.com>
Date: Thu,  3 Apr 2003 11:49:01 -0800 (PST)
From: Ronald F.Guilmette <rfg@monkeys.com>
Reply-To: Ronald F.Guilmette <rfg@monkeys.com>
To: FreeBSD-gnats-submit@freebsd.org
Cc: rfg@monkeys.com, "Greg A. Woods" <woods@weird.com>
Subject: return values for res_query/res_search/res_mkquery undocumented
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         50573
>Category:       docs
>Synopsis:       resolver(3): return values for res_query/res_search/res_mkquery undocumented
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    lawrance
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Apr 03 11:50:06 PST 2003
>Closed-Date:    Tue Nov 07 19:53:18 GMT 2006
>Last-Modified:  Tue Nov  7 20:00:40 GMT 2006
>Originator:     Ronald F. Guilmette
>Release:        FreeBSD 4.7-RELEASE i386
>Organization:
Infinite Monkeys & Co.
>Environment:
System: FreeBSD segfault.monkeys.com 4.7-RELEASE FreeBSD 4.7-RELEASE #0: Sun Dec 22 23:04:36 PST 2002 rfg@segfault.monkeys.com:/usr/src/sys/compile/rfg20021222 i386

>Description:
	The man page for res_query and res_search and res_mkquery fails to
	document the meaning and/or proper interpretation of the (int) values
	returned from these functions.

>How-To-Repeat:
	man 3 res_query

>Fix:
	The O'Reilly DNS and BIND book, Third Edition, documents the return
	values for rese_search and res_query on page 348, first paragraph.

	These two functions are documented (in that book) as returning -1
	in case of errors or else the size of the (successful) response
	packet.

	This information should be included also on the FreeBSD man page.

	I have no idea what a proper fix would be in the case of res_mkquery.
	i have no idea what this function is supposed to return.
>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->lawrance 
Responsible-Changed-By: lawrance 
Responsible-Changed-When: Sat Nov 4 00:03:54 UTC 2006 
Responsible-Changed-Why:  
This looks like something I can do. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=50573 
State-Changed-From-To: open->patched 
State-Changed-By: lawrance 
State-Changed-When: Sat Nov 4 09:45:10 UTC 2006 
State-Changed-Why:  
The return value for res_mkquery is already documented.  Documentation 
was added for res_search and res_query. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=50573 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/50573: commit references a PR
Date: Sat,  4 Nov 2006 09:42:37 +0000 (UTC)

 lawrance    2006-11-04 09:42:22 UTC
 
   FreeBSD src repository (ports committer)
 
   Modified files:
     lib/libc/net         gethostbyname.3 resolver.3 
   Log:
   Document return values for res_query and res_search.
   h_errno is not an extern int, just a macro providing an integer lvalue.
   
   PR:             doc/50573
   Submitted by:   Ronald F.Guilmette <rfg@monkeys.com>
   Reviewed by:    trhodes
   MFC after:      3 days
   
   Revision  Changes    Path
   1.37      +2 -2      src/lib/libc/net/gethostbyname.3
   1.32      +15 -1     src/lib/libc/net/resolver.3
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: patched->closed 
State-Changed-By: lawrance 
State-Changed-When: Tue Nov 7 19:52:29 UTC 2006 
State-Changed-Why:  
MFCed to RELENG_6.  

http://www.freebsd.org/cgi/query-pr.cgi?pr=50573 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/50573: commit references a PR
Date: Tue,  7 Nov 2006 19:53:25 +0000 (UTC)

 lawrance    2006-11-07 19:52:12 UTC
 
   FreeBSD src repository (ports committer)
 
   Modified files:        (Branch: RELENG_6)
     lib/libc/net         gethostbyname.3 resolver.3 
   Log:
   MFC:
     Document return values for res_query and res_search.
     h_errno is not an extern int, just a macro providing an integer lvalue.
   
     PR:             doc/50573
     Submitted by:   Ronald F.Guilmette <rfg at monkeys.com>
     Reviewed by:    trhodes
   
   Approved by:    re (bmah)
   
   Revision  Changes    Path
   1.34.2.2  +3 -3      src/lib/libc/net/gethostbyname.3
   1.30.2.2  +15 -1     src/lib/libc/net/resolver.3
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
>Unformatted:
