How To Report Issues

Version 9 (Dan Smith, 03/09/2012 09:53 am)

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 7 Dan Smith
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 1 Dan Smith
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.
18 5 Dan Smith
19 5 Dan Smith
h2. Getting your debug log
20 5 Dan Smith
21 9 Dan Smith
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.
22 1 Dan Smith
23 9 Dan Smith
The debug log is cleared every time you start chirp, so the procedure for getting a usable log is:
24 9 Dan Smith
25 9 Dan Smith
1. Start chirp
26 9 Dan Smith
2. Reproduce the failure or bug
27 9 Dan Smith
3. Close chirp
28 9 Dan Smith
4. Copy and send the debug.log before starting chirp again
29 9 Dan Smith
30 9 Dan Smith
Here are some tips for getting to it on the various platforms:
31 9 Dan Smith
32 5 Dan Smith
h3. Windows
33 8 Dan Smith
34 6 Dan Smith
Go to Start->Run and type "%APPDATA%\CHIRP". Your debug.log file will be in the folder that opens.
35 6 Dan Smith
36 1 Dan Smith
h3. Linux and MacOS
37 1 Dan Smith
38 9 Dan Smith
Your debug log should be in your home directory, in .chirp/debug.log. If you don't know how to find this, open up a terminal window and run the following command at the prompt:
39 9 Dan Smith
40 9 Dan Smith
 cp ~/.chirp/debug.log ~/Desktop
41 9 Dan Smith
42 9 Dan Smith
Then close the terminal window. The debug.log file will be on your desktop.
43 7 Dan Smith
44 7 Dan Smith
h2. Filing your report
45 7 Dan Smith
46 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": or "Sign in": link at the top right of this page to do that. Once you are logged in, click the "New issue": link on the menu bar above to get started.