Bug 29402 - Man pages should mention header files
Man pages should mention header files
Status: NEW
Product: xorg
Classification: Unclassified
Component: Documentation
unspecified
All All
: low trivial
Assigned To: Xorg Project Team
Xorg Project Team
2011BRB_Reviewed
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2010-08-04 15:18 UTC by dgatwood
Modified: 2013-04-11 01:52 UTC (History)
3 users (show)

See Also:
i915 platform:
i915 features:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description dgatwood 2010-08-04 15:18:58 UTC
I recently received a complaint from some folks downstream from me that the Xlib man pages don't mention which headers various functions appear in.  Although it is certainly possible for folks to grep for it (assuming they are reasonably command-line savvy), that's really not the best way to get things done, particularly in this day and age when there are GUI IDE users who wouldn't know a CLI from a CFL.  :-)

So please consider adding the header information to the pages wherever possible.  (The specific page this particular developer was complaining about was the XLoadQueryFont man page.)
Comment 1 Julien Cristau 2010-08-05 18:02:28 UTC
On Wed, Aug  4, 2010 at 15:18:58 -0700, bugzilla-daemon@freedesktop.org wrote:

> Although it is certainly possible for folks to grep for it (assuming they are
> reasonably command-line savvy), that's really not the best way to get things
> done, particularly in this day and age when there are GUI IDE users who
> wouldn't know a CLI from a CFL.  :-)
> 
those users probably shouldn't be programming for xlib anyway.