I just pushed some basic man page stuff to the libdrm repo, but won't have time to do any more pages for the next week or two.
But regardless, it would be cool if people could adopt some pages and push them out. The goal is to document every structure and function in the API header files, xf86drm.h and xf86drmMode.h, along with the chipset specific functions for each chipset under include/libdrm/.
I've based the man page template on stuff from X, but it may make sense to create our own man page section or put the functions in a different section, I'm definitely not attached to the current structure.
Thanks,
Hi Jesse
On Mon, Sep 17, 2012 at 5:12 PM, Jesse Barnes jbarnes@virtuousgeek.org wrote:
I just pushed some basic man page stuff to the libdrm repo, but won't have time to do any more pages for the next week or two.
But regardless, it would be cool if people could adopt some pages and push them out. The goal is to document every structure and function in the API header files, xf86drm.h and xf86drmMode.h, along with the chipset specific functions for each chipset under include/libdrm/.
I've based the man page template on stuff from X, but it may make sense to create our own man page section or put the functions in a different section, I'm definitely not attached to the current structure.
I just finished writing a short introduction into libdrm modesetting in form of a working example+comments [1] and then started writing a libdrm-API reference documentation. However, I think I will convert my drafts into man-pages and send them to the list. Thanks for starting it.
Regards David
[1] http://dvdhrm.wordpress.com/2012/09/13/linux-drm-mode-setting-api/
On Mon, 17 Sep 2012 23:13:57 +0200 David Herrmann dh.herrmann@googlemail.com wrote:
Hi Jesse
On Mon, Sep 17, 2012 at 5:12 PM, Jesse Barnes jbarnes@virtuousgeek.org wrote:
I just pushed some basic man page stuff to the libdrm repo, but won't have time to do any more pages for the next week or two.
But regardless, it would be cool if people could adopt some pages and push them out. The goal is to document every structure and function in the API header files, xf86drm.h and xf86drmMode.h, along with the chipset specific functions for each chipset under include/libdrm/.
I've based the man page template on stuff from X, but it may make sense to create our own man page section or put the functions in a different section, I'm definitely not attached to the current structure.
I just finished writing a short introduction into libdrm modesetting in form of a working example+comments [1] and then started writing a libdrm-API reference documentation. However, I think I will convert my drafts into man-pages and send them to the list. Thanks for starting it.
Regards David
[1] http://dvdhrm.wordpress.com/2012/09/13/linux-drm-mode-setting-api/
Perfect, I was hoping someone would do an overview page or two for the man pages. Maybe a top level 'drm' man page with references to a high level 'drm kms' page and another for ttm + gem?
Thanks,
dri-devel@lists.freedesktop.org