[Xapian-tickets] [Xapian] #569: omindex --help text for -F misleading
Xapian
nobody at xapian.org
Sun Dec 11 09:05:11 GMT 2011
#569: omindex --help text for -F misleading
--------------------+-------------------------------------------------------
Reporter: catkin | Owner: olly
Type: defect | Status: assigned
Priority: normal | Milestone: 1.3.0
Component: Omega | Version: 1.2.5
Severity: normal | Keywords:
Blockedby: | Platform: All
Blocking: |
--------------------+-------------------------------------------------------
Comment(by catkin):
Ah -- I had misunderstood that omindex only derives MIME types by mapping
from extensions. It was so? It has been changed?
If I understood exactly how omindex worked then I could be more helpful
with suggestions. That is the issue; it is hard to find out how omindex
works regards extensions and MIME types without inspecting the source code
and that is a non-trivial task, not something many users are willing or
able to do.
Keeping the help useful for quick reference is worthwhile but it would be
helpful if the man page was a complete reference, or included a link to a
complete reference.
How about having both the existing --help and a --help_verbose option?
The man page could be generated from the --help_verbose source.
Regards the maintenance headache, there's a note at the bottom of the
table giving a command to extract what can be extracted from the source
code; some further text would have to be added to complete the table as
is. I would be willing to work on automating that as far as practicable.
--
Ticket URL: <http://trac.xapian.org/ticket/569#comment:5>
Xapian <http://xapian.org/>
Xapian
More information about the Xapian-tickets
mailing list