Bug 99985

Summary:	RFE: gbm needs a man page
Product:	Mesa	Reporter:	Edward O'Callaghan <funfunctor>
Component:	Other	Assignee:	mesa-dev
Status:	RESOLVED WONTFIX	QA Contact:	mesa-dev
Severity:	normal
Priority:	medium
Version:	git
Hardware:	Other
OS:	All
Whiteboard:
i915 platform:		i915 features:

Description Edward O'Callaghan 2017-02-27 12:48:28 UTC

Hi, this is just a RFE.

The gbm mechanism is poorly documented to the point where one needs to look in the header and vaguely workout how to use it. We should at least provide a man page for its various entry-points and a short explanation of what each function is for.

Kindly, Edward.

Comment 1 Emil Velikov 2017-02-27 13:20:14 UTC

This reminds me something that I've mentioned a while back:

We really want to move the doxygen style documentation to the actual headers. Not to mention that we can add a Doxygen file and get the tool to generate the documentation for us ;-)

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.