Bug 50573

Summary:	resolver(3): return values for res_query/res_search/res_mkquery undocumented
Product:	Documentation	Reporter:	Ronald F. Guilmette <rfg>
Component:	Books & Articles	Assignee:	Sam Lawrance <lawrance>
Status:	Closed FIXED
Severity:	Affects Only Me	CC:	rfg
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description Ronald F. Guilmette 2003-04-03 20:50:06 UTC

	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.

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.
How-To-Repeat: 	man 3 res_query

Comment 1 Sam Lawrance freebsd_committer

2006-11-04 00:03:54 UTC

Responsible Changed
From-To: freebsd-doc->lawrance

This looks like something I can do.

Comment 2 dfilter service freebsd_committer

2006-11-04 09:42:37 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"

Comment 3 Sam Lawrance freebsd_committer

2006-11-04 09:45:10 UTC

State Changed
From-To: open->patched

The return value for res_mkquery is already documented.  Documentation 
was added for res_search and res_query.

Comment 4 Sam Lawrance freebsd_committer

2006-11-07 19:52:29 UTC

State Changed
From-To: patched->closed

MFCed to RELENG_6.

Comment 5 dfilter service freebsd_committer

2006-11-07 19:53:25 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"