241333 - Clarify mail/news QA troubleshooting instruction on IMAP/POP3/SMTP log

Status: RESOLVED FIXED

(Documentation Graveyard :: Web Developer, defect)

Description

[Christian Eyrich]

It often happens, that users create IMAP logs when POP3 or SMTP are needed. They
just copy the examples with "NSPR_LOG_MODULES=IMAP:5" and miss the note "For
POP, NNTP, or SMTP, replace IMAP with POP3, NNTP, or SMTP respectively." from
the paragraph above.

So I guess we've to modify the text. First I'd emphasize the above sentence more
(<strong> or <b> or so).
And the lines down should look like "NSPR_LOG_MODULES=<a
href="#protocol"protocol</a>:5". The anchor #protocol could be the sentence
mentioned.
If the users still not notice and replace "protocol" by "IMAP" or the other
protocols, creation of the log will fail - maybe the user will notice this.

Comment 1

[Christian Eyrich]

Attachment: proposed patch

That's what I meant.

Comment 2

[Christian Eyrich]

Comment on attachment 147186 [details] [diff] [review]
proposed patch

David, asking you for rv since you also know the problem of wrongly created
IMAP logs.

Comment 3

[R.J. Keller]

Comment on attachment 147186 [details] [diff] [review]
proposed patch

This patch looks good to me, but I cannot officially give review for things
outside my module.

sspitzer might not be a bad person to ask review from for this kind of
documentation.

Sorry I couldn't help more :(.

Comment 4

[(not reading, please use [e-mail] instead)]

Comment on attachment 147186 [details] [diff] [review]
proposed patch

sr=sspitzer

Comment 5

[R.J. Keller]

Fix checked in.

Comment 6

[(not reading, please use [e-mail] instead)]

I made a few more changes, see
http://www.mozilla.org/webtools/bonsai/cvsview2.cgi?diff_mode=context&whitespace_mode=show&file=mail-troubleshoot.html&branch=&root=/cvsroot&subdir=mozilla-org/html/quality/mailnews&command=DIFF_FRAMESET&rev1=1.16&rev2=1.17