[Xapian-tickets] [Xapian] #286: xapian-inspect.1 COMMANDS

[Xapian]

#286: xapian-inspect.1 COMMANDS
-------------------------+--------------------------------------------------
 Reporter:  rurban       |        Owner:  olly
     Type:  enhancement  |       Status:  new 
 Priority:  normal       |    Milestone:      
Component:  Other        |      Version:      
 Severity:  normal       |   Resolution:      
 Keywords:               |    Blockedby:      
 Platform:  All          |     Blocking:      
-------------------------+--------------------------------------------------

Comment(by olly):

 Hmm, yes, the commands aren't easily discoverable currently.

 Problem is this is a generated file, so with this patch we lose the
 advantages of automatically generating it (that the man page and --help
 are kept in sync).  My experience is that if you have two places
 independently documenting the same thing, people tend to only update one
 of them and you end up partly out of date documentation in one or both
 places.  It also adds work even when you do remember.

 Also, this list of commands isn't automatically kept in step with the
 output of the help command, which is another case of the same issue.

 The better options seem to be either adding this to the output of xapian-
 inspect --help
 (from where it will automatically end up in the man page, and the text can
 come from the same source as the help command output) or saying "Type
 'help' for a list of commands" on start-up.  Or perhaps both.

-- 
Ticket URL: <http://trac.xapian.org/ticket/286#comment:1>
Xapian <http://xapian.org/>
Xapian