Subject: lib/11172: the `heimdal' krb5 library documentation is severely lacking
To: None <>
From: Paul Kranenburg <>
List: netbsd-bugs
Date: 10/08/2000 15:30:09
>Number:         11172
>Category:       lib
>Synopsis:       the `heimdal' krb5 library documentation is severely lacking
>Confidential:   no
>Severity:       serious
>Priority:       high
>Responsible:    lib-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sun Oct 08 15:30:00 PDT 2000
>Originator:     Paul Kranenburg
>Release:        NetBSD-current & NetBSD 1.5ALPHA
System: NetBSD sam 1.5E NetBSD 1.5E (SAM) #74: Sun Sep 10 00:35:00 MEST 2000 pk@sam:/usr/src/sys/arch/sparc/compile/SAM sparc

	There is virtually no documentation on the heimdal kerberos V
	implementation as currently distributed with NetBSD. In section
	3 of manual pages only a few (and, as it seems to me, randomly
	chosen) functions are described.

	Also notably missing is an overview of the API provided by the
	heimdal libraries, which makes it difficult to start writing
	applications that want to incorporate kerberos functionality.

	The absence of such docs also makes it difficult for developers
	to work on the libraries, as it is hard to find out whether
	bug fixes and/or other changes will affect programming interface.
	Spot a bug in the library and wonder whether a possible fix which
	involves changing a function signature would be acceptable.
	Provide an Application Programming Interface overview document
	and supply a section 3 entry for each item in it.