thunderbird / thunderbird/developer-docs
Add a user-friendly guide to setting up logging (especially on windows)
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 114
- Forks
- 86
- Avg merge
- 2h 37m
- Merged PRs (30d)
- 1
Description
It'd be great to have a nice simple guide to point users at when we're asking them to collect log output for us.
Especially for windows users. A nice step-by-step guide with the bare basics.
In a bugzilla comment I want to be able to ask:
Could you try logging with
MOZ_LOG="compact:3"? Here's a guide on how to set that up: http://...
In particular, what's the simplest way to set up MOZ_LOG and MOZ_LOG_FILE on windows, without requiring commandline use? There's the global environment variable editor, but that seems a bit heavy handed. Is there a simpler way?
For reference, there's https://firefox-source-docs.mozilla.org/xpcom/logging.html ... but that's waaay too complex to expect a user to read, and has lots of firefox-only detail.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing Firefox logging guide and investigate the simplest Windows setup for MOZ_LOG and MOZ_LOG_FILE without command-line use. The work is done when there is a concise, step-by-step guide covering the bare basics that can be linked from bug reports.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100