[Bug 3961] New: inconsistency in spamc documentation

[bu...@bugzilla.spamassassin.org]

http://bugzilla.spamassassin.org/show_bug.cgi?id=3961

           Summary: inconsistency in spamc documentation
           Product: Spamassassin
           Version: 3.0.1
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: P5
         Component: spamc/spamd
        AssignedTo: dev@spamassassin.apache.org
        ReportedBy: alex@ergens.op.het.net


Depending on what part of the documentation is read, I either need to specify "-
x" or leave it out to get certain behaviour.

In the documentation for spamc:
   -x   Don't use the 'safe fallback' error-recovery method, which
        passes through the unaltered message if an error occurs.
        Instead, exit with an error code ...

I read this as: "I need to specify -x to get the error codes specified
in the documentation."

Then, under "exit codes":

   If the -x option is specified, 'safe fallback' will be disabled, and
   certain error conditions will NOT (emphasis by me) result in an error
   code.  Instead, the message will be passed through unmodified and ...

I read this as: "I must NOT specify -x to get the error codes specified
in the documentation."

If the documentation is technically correct, it may be too hard to grasp for 
people to understand.



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.