Opened 7 years ago

Closed 7 years ago

#4176 defect closed fixed (fixed)

twistd web "-n" option documentation is backwards

Reported by: Jean-Paul Calderone Owned by:
Priority: normal Milestone:
Component: web Keywords: documentation, easy
Cc: jesstess Branch:
Author:

Description

twistd web --help produces, amongst other things, this output:

  -n, --notracebacks      Display tracebacks in broken web pages. Displaying
                          tracebacks to users may be security risk!

Okay... the option is called notracebacks and the behavior of supplying it is for tracebacks to be displayed? Not likely. Displaying tracebacks is the default, and this option really does disable that.

Attachments (1)

notracebacks.patch (3.0 KB) - added by jesstess 7 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 7 years ago by jesstess

Cc: jesstess added

Grepping around I see:

  • twisted/python/zsh/_mktap:'(--notracebacks)-n[Display tracebacks in broken web pages. Displaying tracebacks to users may be security risk!]' \
  • twisted/python/zsh/_mktap:'(-n)--notracebacks[Display tracebacks in broken web pages. Displaying tracebacks to users may be security risk!]' \
  • twisted/python/zsh/_twistd:'(--notracebacks)-n[Display tracebacks in broken web pages. Displaying tracebacks to users may be security risk!]' \
  • twisted/python/zsh/_twistd:'(-n)--notracebacks[Display tracebacks in broken web pages. Displaying tracebacks to users may be security risk!]' \
  • twisted/web/tap.py: ["notracebacks", "n", "Display tracebacks in broken web pages. " +

So these all probably need changing.

comment:2 Changed 7 years ago by jesstess

Owner: changed from jknight to jesstess

Changed 7 years ago by jesstess

Attachment: notracebacks.patch added

comment:3 Changed 7 years ago by jesstess

Keywords: review added
Owner: jesstess deleted

Display tracebacks ==> Do not display tracebacks, for the 5 cases above.

comment:4 Changed 7 years ago by TimAllen

I've reviewed this and I approve of it being committed, but I can't actually commit it myself. I'll leave this ticket in the review queue, waiting for somebody with commit access.

comment:5 Changed 7 years ago by jesstess

Keywords: review removed
Owner: set to jesstess

comment:6 Changed 7 years ago by jesstess

Resolution: fixed
Status: newclosed

(In [27854]) Apply notracebacks.patch

Author: jesstess Reviewer: TimAllen Fixes: #4176

twistd web '-n' documentation should say that it _disables_ tracebacks.

comment:7 Changed 6 years ago by <automation>

Owner: jesstess deleted
Note: See TracTickets for help on using tickets.