Bug 6548 - [review] [doc] spamd protocol examples are wrong
Summary: [review] [doc] spamd protocol examples are wrong
Status: RESOLVED FIXED
Alias: None
Product: Spamassassin
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 3.3.1
Hardware: All All
: P2 trivial
Target Milestone: 3.3.2
Assignee: SpamAssassin Developer Mailing List
URL:
Whiteboard: RTC for 3.3.2
Keywords:
Depends on:
Blocks:
 
Reported: 2011-03-04 09:38 UTC by Daniel Lemke
Modified: 2011-05-05 17:28 UTC (History)
3 users (show)


Attachment Type Modified Status Actions Submitter/CLA Status
patch to correct spamd protocol examples patch None Daniel Lemke [HasCLA]
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Daniel Lemke 2011-03-04 09:38:33 UTC 
Looks like the examples for reporting and revoking a message in the spamd protocol documentation are wrong.

See this discussion for more information: 
http://old.nabble.com/SpamAssassin-protocol-examples-to31001608.html#a31068134
Comment 1 Karsten Bräckelmann 2011-03-04 12:58:27 UTC 
Also see bug 5398 and revision 528556, which appears to have changed a different header / protocol example than reported.
Comment 2 Daniel Lemke 2011-03-09 02:59:14 UTC 
Created attachment 4848 [details]
patch to correct spamd protocol examples
Comment 3 Daniel Lemke 2011-03-09 03:00:47 UTC 
(In reply to comment #1)
> Also see bug 5398 and revision 528556, which appears to have changed a
> different header / protocol example than reported.

Yes, that's the reason I put Justin on cc, I guess this was a small mistake.

I attached a patch to correct the examples.

Daniel
Comment 4 Daniel Lemke 2011-03-18 06:53:29 UTC 
Any chance to commit this one?
Comment 5 Mark Martinec 2011-03-22 22:11:25 UTC 
> Any chance to commit this one?

+1  thanks for noticing and fixing the documentation bug

trunk:
  Bug 6548: spamd protocol examples are wrong' spamd/PROTOCOL
Sending  spamd/PROTOCOL
Committed revision 1084457.
Comment 6 Karsten Bräckelmann 2011-03-23 00:54:46 UTC 
Hmm... Looks good to me, makes a hell of a lot more sense. Thanks, Daniel.
Though did you really have to remove the trailing newline, Mark? I like trailing newlines. ;)

+1
Comment 7 Mark Martinec 2011-03-23 21:25:13 UTC 
> Though did you really have to remove the trailing newline, Mark? I like
> trailing newlines. ;)

trunk:
  [doc] re-append an empty line to spamd/PROTOCOL, Guenther liked it :)
Sending spamd/PROTOCOL
Committed revision 1084826.
Comment 8 Kevin A. McGrail 2011-03-24 10:58:38 UTC 
(In reply to comment #7)
> > Though did you really have to remove the trailing newline, Mark? I like
> > trailing newlines. ;)
> 
> trunk:
>   [doc] re-append an empty line to spamd/PROTOCOL, Guenther liked it :)
> Sending spamd/PROTOCOL
> Committed revision 1084826.

+1 for 3.3.2
Comment 9 Mark Martinec 2011-05-05 17:28:06 UTC 
3.3:
  $ svn ci -m 'Bug 6548: spamd protocol examples are wrong'
  Sending spamd/PROTOCOL
Committed revision 1099882.