[PATCH libdrm 0/4] Overview man-pages for libdrm

David Herrmann dh.herrmann at googlemail.com
Sun Sep 23 07:40:03 PDT 2012


Hi

This tries to continue the effort to document libdrm. I actually removed the
X11-like man-page generation code as autotools now support man_MANS. The
previous approach required every manpage to be in the same man-group. However,
API calls belong in man3 and overview pages into man7. So I just use the simpler
approach without all the replacements. It turns out, no man-page did use them so
we can add it again if one really needs them.

The other 3 patches add a generic drm.7 overview page, a drm-kms.7 overview page
and a drm-memory.7 overview page. Also some aliases are installed, including
  drm-gem.7 => drm-memory.7
  drm-ttm.7 => drm-memory.7
Please note that you cannot open the aliased pages with "man ./man/drm-gem.7".
You must install them before they work correctly as they require the directory
to be "man7" not "man".

Anyway, any comments are welcome. This is really just something to start on and
any corrections are appreciated.

I have also added many dead-links to some other overview pages, including
  drm-prime.7: Short introduction to the PRIME API
  drm-intel.7,
  drm-radeon.7,
  drm-noueveau.7: Driver-dependent DRM API
And many links to undocumented API calls. Feel free to write short stub-pages
for any of them. It's better than nothing.

I am also no groff/troff expert, but I think the pages look quite nice. And I
recommend reading the pages with "man ./man/drm*.7" if you want to review them.
Plain troff is really ugly to read.

Regards
David

Some parts are copied from (I hope nobody minds?):
  http://lwn.net/Articles/283798/
  http://lwn.net/Articles/499261/

David Herrmann (4):
  man: use automake man_MANS to allow multiple suffixes
  man: add man/drm.7 overview page
  man: add KMS overview page
  man: add drm-memory man-page

 man/Makefile.am             |  22 +--
 man/drm-gem.7               |   1 +
 man/drm-kms.7               | 269 +++++++++++++++++++++++++++++
 man/drm-memory.7            | 412 ++++++++++++++++++++++++++++++++++++++++++++
 man/drm-mm.7                |   1 +
 man/drm-ttm.7               |   1 +
 man/drm.7                   |  99 +++++++++++
 man/drmAvailable.3          |  26 +++
 man/drmAvailable.man        |  25 ---
 man/drmHandleEvent.3        |  48 ++++++
 man/drmHandleEvent.man      |  45 -----
 man/drmModeGetResources.3   |  89 ++++++++++
 man/drmModeGetResources.man |  79 ---------
 13 files changed, 957 insertions(+), 160 deletions(-)
 create mode 100644 man/drm-gem.7
 create mode 100644 man/drm-kms.7
 create mode 100644 man/drm-memory.7
 create mode 100644 man/drm-mm.7
 create mode 100644 man/drm-ttm.7
 create mode 100644 man/drm.7
 create mode 100644 man/drmAvailable.3
 delete mode 100644 man/drmAvailable.man
 create mode 100644 man/drmHandleEvent.3
 delete mode 100644 man/drmHandleEvent.man
 create mode 100644 man/drmModeGetResources.3
 delete mode 100644 man/drmModeGetResources.man

-- 
1.7.12.1



More information about the dri-devel mailing list