Project

General

Profile

How To Report Issues » History » Version 34

Dan Smith, 10/28/2024 12:01 PM

1 30 Dan Smith
{{>toc}}
2 17 Dan Smith
# How To Report Issues
3 1 Dan Smith
4 17 Dan Smith
## First things first!
5 1 Dan Smith
6 17 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).
7 7 Dan Smith
8 25 Dan Smith
Please *DO NOT* attach the manufacturer's software or documentation to the issue. Even if you think the file is freely available via download elsewhere, that does not mean you can legally distribute it yourself. Posting it here also opens up the CHIRP website and community to potential action by owners of those materials. If it is downloadable somewhere, feel free to post a link but *DO NOT* attach it to the issue.
9 16 Dan Smith
10 33 Dan Smith
## Best results: report from within CHIRP itself!
11 1 Dan Smith
12 33 Dan Smith
If possible, it is highly recommended that you report your bug from *within CHIRP itself*. Doing this will help ensure that your bug report includes information about your system that we need in order to help you. To do this, go to *Help* -> *Report or update a bug* and follow the steps. Do this reporting step after you have reproduced the problem, and with the affected radio image (or CSV) file open and selected as the current tab. Even if you're experiencing a failure to download, try and let it fail, then do the reporting step.
13
14
<img src="clipboard-202408121550-wyk9m.png" height="300"/>
15
16
Further updates to a given bug can be done through the same tool and help provide us all the information we need each time.
17
18
## Backup procedure: Manual bug reporting
19
20
If you are unable to report the issue from inside CHIRP, you can follow these older bug reporting instructions. Only use this if you are unable to report from within CHIRP, or CHIRP is failing to start or work properly.
21
22
### Effective Bug Reporting
23
24 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:
25
26
1. What is the behavior you are seeing?
27
2. What is the behavior you were expecting?
28
3. Can you reproduce the problem all the time?
29
4. What are the steps required to reproduce the problem?
30
5. Is this specific to a certain radio model (driver) or something that you can reproduce with another radio?
31 27 Dan Smith
32 18 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. That means the `.img` file that you generate by downloading from your radio and then doing **File -> Save As**. Note that "live mode" radios will not have a `.img` file, so the `debug.log` is all that is needed. 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.
33 10 Dan Smith
34 1 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)
35 17 Dan Smith
36 33 Dan Smith
### Getting your debug log
37 13 Jens Jensen
38 1 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.
39 9 Dan Smith
40 32 Alexandre J. Raymond
The debug log is cleared every time you start CHIRP, so the procedure for getting a usable log is:
41 9 Dan Smith
42
1. Start CHIRP
43 1 Dan Smith
2. Reproduce the failure or bug
44 29 Dan Smith
3. Copy and send the debug log before starting CHIRP again
45
46 33 Dan Smith
#### Modern CHIRP
47 1 Dan Smith
48 29 Dan Smith
**If you are running CHIRP-next:** You can access a copy of your debug log from the *Help* menu. Do this just after you reproduce the problem.
49 9 Dan Smith
50 1 Dan Smith
<img src="Screenshot 2024-03-04 at 3.37.10 PM.png" height="300"/>
51 28 Dan Smith
52 34 Dan Smith
Here are some tips for getting the **legacy** CHIRP `debug.log` on the various platforms (or for use if CHIRP is not starting at all):
53 1 Dan Smith
54 33 Dan Smith
#### CHIRP-legacy on Windows
55 20 Dan Smith
56 1 Dan Smith
Go to Start->Run and type `%APPDATA%\CHIRP` (exactly as it is, including the percent signs). Your `debug.log` file will be in the folder that opens.
57 28 Dan Smith
58 33 Dan Smith
#### CHIRP-legacy on Linux and MacOS
59 21 Dan Smith
60 1 Dan Smith
Your debug log should be in your home directory, in `.chirp/debug.log`.
61 17 Dan Smith
If you don't know how to find this, open up a terminal window.
62 11 Jens Jensen
(Mac: click on spotlight (the magnifying glass icon at top right corner), and type `terminal`)
63 15 Jens Jensen
64 11 Jens Jensen
Run the following command at the prompt:
65 17 Dan Smith
66 1 Dan Smith
```
67 17 Dan Smith
cp ~/.chirp/debug.log ~/Desktop
68
```
69 9 Dan Smith
70 21 Dan Smith
Then close the terminal window. The `debug.log` file will be on your desktop.
71 7 Dan Smith
72 33 Dan Smith
### Filing your report
73 7 Dan Smith
74 31 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://chirpmyradio.com/account/register) or [Sign in](http://chirpmyradio.com/login) link at the top right of this page to do that. Once you are logged in, click the [New issue](http://chirpmyradio.com/projects/chirp/issues/new) link on the menu bar above to get started.
75 26 Dan Smith
76
**IMPORTANT:** Please read the following instructions **before** filing an issue. Failure to include details about your problem may cause it to be closed as incomplete or ignored.
77
{{include(IssueInstructions)}}