Bug 1565 - difficult keeping documentation of commands / configuration parameters up to date
Summary: difficult keeping documentation of commands / configuration parameters up to ...
Status: NEW
Alias: None
Product: ThinLinc
Classification: Unclassified
Component: Documentation (show other bugs)
Version: trunk
Hardware: PC Linux
: P2 Enhancement
Target Milestone: MediumPrio
Assignee: Peter Åstrand
Depends on:
Reported: 2005-10-10 13:44 CEST by Erik Forsberg
Modified: 2018-12-18 13:11 CET (History)
0 users

See Also:
Acceptance Criteria:


Description Erik Forsberg cendio 2005-10-10 13:44:46 CEST
Chapter 13, "Commands on the ThinLinc server" is hard to maintain. Each time we
add a command, a section needs to be written. Keeping it up to date is also hard. 

Another problematic section is 6.8, "Client configuration storage", which lists
"all" configuration parameters in the client configuration file/registry. The
same  maintenance problems occur here as in the list of commands.

Having a list of commands with usage in the UG is probably a good idea. I
personally sometimes prefer to be able to read about the commands in a document,
rather than having to run ./command --help. Especially since we don't have any
manual pages.

The list of client configuration parameters is perhaps less useful, and can
probably be moved to our internal documentation.

With our new-found knowledge of epydoc, it may be possible to create a system
that extracts documentation from the binaries, collecting them into a
commands.xml. We should probably also write a command that looks through the
generated rpms to see which binaries are actually shipped, to make sure we don't
miss anything. 

See also the (short) discussion in komintern begins with article 217147.

Note You need to log in before you can comment on or make changes to this bug.