site_archiver@lists.apple.com Delivered-To: darwin-kernel@lists.apple.com On Nov 3, 2006, at 1:45 AM, Stephane wrote: It's incorrect in both the header and documentation: http://developer.apple.com/documentation/Darwin/Reference/KPI_Reference/kern... kern_control.h Bug report filed: (Problem ID: 4816011) --------- "Return Value You do not enqueue any data when you call this function... OK, this makes more sense. -- Terry _______________________________________________ Do not post admin requests to the list. They will be ignored. Darwin-kernel mailing list (Darwin-kernel@lists.apple.com) Help/Unsubscribe/Update your Subscription: http://lists.apple.com/mailman/options/darwin-kernel/site_archiver%40lists.a... On Nov 3, 2006, at 1:13 AM, Terry Lambert wrote: On Nov 2, 2006, at 6:09 AM, Stephane wrote: The "Return Value" description for the ctl_getenqueuespace API is wrong. It looks like to be a copy-paste from the enqueue calls. What is the correct description? It's an errno_t - I looked at both your linked documentation and the current releases source code, and it looks correct; why do you think it's incorrect? 0 - Data was enqueued to be read by the client. EINVAL - Invalid parameters." IMHO, this is a copy paste from the ctl_enqueuembuf description. FFR, the KPI documentation for this area is parsed out in "doc book" format from the header file, and the string "Return Value" is derived from the documentation element "@result". If you had referenced "@result in the header 'bsd/sys/kern_control.h' is wrong for ctl_getenqueuespace", the bug report would have ended up in the right place to get it fixed (which is the networking component, not the documentation component). I've moved things around with the bug report and renamed it, per the previous sentence. This email sent to site_archiver@lists.apple.com