How To Report Issues

Version 14 (Jens Jensen, 01/15/2014 09:16 pm)

1 1 Dan Smith
h1. How To Report Issues
2 1 Dan Smith
3 7 Dan Smith
h2. First things first!
4 1 Dan Smith
5 14 Jens Jensen
Before you file a bug, *please test the latest Development Version of CHIRP to see if your issue has been fixed*. These builds are generated automatically every night when there is a change, and they are available from the bottom of the "download page":/projects/chirp/wiki/download.
6 7 Dan Smith
7 2 Dan Smith
h2. Effective Bug Reporting
8 2 Dan Smith
9 1 Dan Smith
Effective reporting of a bug or feature is critical to getting the issue resolved in a timely manner. If bug descriptions are difficult to understand or reproduce, they are less likely to receive attention. When you are crafting your bug report, try to answer the following questions:
10 1 Dan Smith
11 1 Dan Smith
1. What is the behavior you are seeing?
12 1 Dan Smith
2. What is the behavior you were expecting?
13 1 Dan Smith
3. Can you reproduce the problem all the time?
14 1 Dan Smith
4. What are the steps required to reproduce the problem?
15 1 Dan Smith
5. Is this specific to a certain radio model (driver) or something that you can reproduce with another radio?
16 1 Dan Smith
17 13 Jens Jensen
In most cases, *it is important to attach an image of your radio to the bug* so that a developer can look at the exact state and determine what the problem is. It is often helpful describe what you expect to see in a given memory location, as well as what you actually see. If relevant or difficult to describe what you are seeing, attaching a screenshot of the behavior may also be helpful.
18 5 Dan Smith
19 10 Dan Smith
For more information about how to file an effective bug report, please see Eric S. Raymond's "How to ask questions the smart way":http://catb.org/esr/faqs/smart-questions.html
20 10 Dan Smith
21 5 Dan Smith
h2. Getting your debug log
22 5 Dan Smith
23 13 Jens Jensen
If you are expecting something to happen (such as importing from a file, or setting a memory) and CHIRP appears to ignore the request, *you probably should include your debug.log*. If you are getting an error message, you should definitely include the log.
24 1 Dan Smith
25 9 Dan Smith
The debug log is cleared every time you start chirp, so the procedure for getting a usable log is:
26 9 Dan Smith
27 9 Dan Smith
1. Start chirp
28 9 Dan Smith
2. Reproduce the failure or bug
29 9 Dan Smith
3. Close chirp
30 9 Dan Smith
4. Copy and send the debug.log before starting chirp again
31 9 Dan Smith
32 9 Dan Smith
Here are some tips for getting to it on the various platforms:
33 9 Dan Smith
34 5 Dan Smith
h3. Windows
35 8 Dan Smith
36 6 Dan Smith
Go to Start->Run and type "%APPDATA%\CHIRP". Your debug.log file will be in the folder that opens.
37 6 Dan Smith
38 1 Dan Smith
h3. Linux and MacOS
39 1 Dan Smith
40 11 Jens Jensen
Your debug log should be in your home directory, in .chirp/debug.log.
41 11 Jens Jensen
If you don't know how to find this, open up a terminal window.
42 13 Jens Jensen
(Mac: To open a terminal window, click on spotlight [the magnifying glass icon at top right corner], and type "terminal")
43 11 Jens Jensen
44 11 Jens Jensen
Run the following command at the prompt:
45 9 Dan Smith
46 9 Dan Smith
 cp ~/.chirp/debug.log ~/Desktop
47 9 Dan Smith
48 9 Dan Smith
Then close the terminal window. The debug.log file will be on your desktop.
49 7 Dan Smith
50 7 Dan Smith
h2. Filing your report
51 7 Dan Smith
52 7 Dan Smith
In order to file a new bug report or feature request, you must first create (or sign into) an account. Click the "Register":http://chirp.danplanet.com/account/register or "Sign in":http://chirp.danplanet.com/login link at the top right of this page to do that. Once you are logged in, click the "New issue":http://chirp.danplanet.com/projects/chirp/issues/new link on the menu bar above to get started.