Closed Bug 241333 Opened 21 years ago Closed 20 years ago

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

Categories

(Documentation Graveyard :: Web Developer, defect)

defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: ch.ey, Assigned: ch.ey)

References

()

Details

Attachments

(1 file)

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.
Assignee: endico → sspitzer
Component: webmaster@mozilla.org → Mozilla Developer
Product: mozilla.org → Documentation
Summary: Clarify the examples and make them user proof → Clarify mail/news QA troubleshooting instruction on IMAP/POP3/SMTP log
Version: other → unspecified
Attached patch proposed patch (deleted) — Splinter Review
That's what I meant.
Component: Mozilla Developer → User
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.
Attachment #147186 - Flags: review?(bienvenu)
Attachment #147186 - Flags: review?(bienvenu) → review+
Attachment #147186 - Flags: superreview?(rlk)
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 :(.
Attachment #147186 - Flags: superreview?(rlk) → superreview?(sspitzer)
Comment on attachment 147186 [details] [diff] [review]
proposed patch

sr=sspitzer
Attachment #147186 - Flags: superreview?(sspitzer) → superreview+
Assignee: sspitzer → ch.ey
Fix checked in.
Status: NEW → RESOLVED
Closed: 20 years ago
Component: User → Web Developer
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: