Opened 16 years ago

Closed 16 years ago

#286 closed enhancement (fixed)

xapian-inspect.1 COMMANDS

Reported by: Reini Urban Owned by: Olly Betts
Priority: normal Milestone: 1.0.8
Component: Other Version: 1.0.7
Severity: normal Keywords:
Cc: Blocked By:
Blocking: Operating System: All

Description

Attached patch adds the interactive commands to xapian-inspect.1

Attachments (1)

xapian-inspect.1.patch (944 bytes ) - added by Reini Urban 16 years ago.

Download all attachments as: .zip

Change History (5)

by Reini Urban, 16 years ago

Attachment: xapian-inspect.1.patch added

comment:1 by Olly Betts, 16 years ago

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.

comment:2 by Olly Betts, 16 years ago

Milestone: 1.0.8
Status: newassigned
Version: 1.0.7

comment:3 by Olly Betts, 16 years ago

The commands are now listed when xapian-inspect is run in trunk [11145].

comment:4 by Olly Betts, 16 years ago

Resolution: fixed
Status: assignedclosed

Backported to 1.0 branch [11146].

Note: See TracTickets for help on using tickets.