Bug 90030 - colord lacks detailed documentation
Summary: colord lacks detailed documentation
Status: NEW
Alias: None
Product: colord
Classification: Unclassified
Component: client (show other bugs)
Version: unspecified
Hardware: All All
: medium normal
Assignee: Richard Hughes
QA Contact:
Depends on:
Reported: 2015-04-14 18:46 UTC by Sebastián Puebla
Modified: 2015-05-12 22:44 UTC (History)
0 users

See Also:
i915 platform:
i915 features:

DocBook source for cd-iccdump(1) manual page (3.24 KB, text/sgml)
2015-05-12 22:44 UTC, Sebastián Puebla

Description Sebastián Puebla 2015-04-14 18:46:40 UTC
The manual pages of colord does not document the client programs and daemon configuration file with detail enough to allow an administrator to use this software.

For example, the manual page for colormgr(1) describes its create-device command as follows:

create-device device-id scope
  Create a device

Another example is the man page for cd-create-profile(1): it does not even mention whether that program processes input files.

The manual pages for client programs should document with enough detail all *supported* command line arguments and options, the allowed values of certain options and command parameters, the format of input and output files (if a program actually reads or write files), possible exit status, and so on.  The daemon configuration file and any non-standard file formats created or consumed by client programs should be described in man section 5.
Comment 1 Sebastián Puebla 2015-05-12 22:44:30 UTC
Created attachment 115727 [details]
DocBook source for cd-iccdump(1) manual page

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.