Bug 29402 - Man pages should mention header files
Summary: Man pages should mention header files
Status: NEW
Alias: None
Product: xorg
Classification: Unclassified
Component: Documentation (show other bugs)
Version: unspecified
Hardware: All All
: low trivial
Assignee: Xorg Project Team
QA Contact: Xorg Project Team
URL:
Whiteboard: 2011BRB_Reviewed
Keywords:
Depends on:
Blocks:
 
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.


bug/show.html.tmpl processed on Aug 27, 2016 at 15:05:37.
(provided by the Example extension).