[Xapian-tickets] [Xapian] #569: omindex --help text for -F misleading
Xapian
nobody at xapian.org
Thu Dec 22 03:28:48 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 olly):
Since 1.2.4 (so just over a year):
> Optionally use libmagic to detect MIME types for files for which we have
no
> extension mapping, which allows us to handle files with a misleading
> extension, or no extension at all. (ticket#114)
It looks like the documentation wasn't updated for this change though. I
will
sort that out.
I favour keeping --help output and the man pages aligned and fairly brief,
and
leaving more in depth documentation in the .rst docs. There's certainly
an
argument for having more in the man pages than --help output, but that
would
mean having three different levels of documentation for each program and I
think
that will inevitably lead to more omissions in keeping the docs up to
date.
--
Ticket URL: <http://trac.xapian.org/ticket/569#comment:6>
Xapian <http://xapian.org/>
Xapian
More information about the Xapian-tickets
mailing list