How To Report Issues » History » Version 32
Alexandre J. Raymond, 05/24/2024 10:04 AM
Make chirp uppercase throughout
| 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 | 17 | Dan Smith | ## Effective Bug Reporting |
| 11 | 2 | Dan Smith | |
| 12 | 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: |
| 13 | |||
| 14 | 1. What is the behavior you are seeing? |
||
| 15 | 2. What is the behavior you were expecting? |
||
| 16 | 3. Can you reproduce the problem all the time? |
||
| 17 | 4. What are the steps required to reproduce the problem? |
||
| 18 | 5. Is this specific to a certain radio model (driver) or something that you can reproduce with another radio? |
||
| 19 | |||
| 20 | 27 | 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. |
| 21 | 5 | Dan Smith | |
| 22 | 18 | 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) |
| 23 | 10 | Dan Smith | |
| 24 | 17 | Dan Smith | ## Getting your debug log |
| 25 | 5 | Dan Smith | |
| 26 | 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. |
| 27 | 1 | Dan Smith | |
| 28 | 32 | Alexandre J. Raymond | The debug log is cleared every time you start CHIRP, so the procedure for getting a usable log is: |
| 29 | 9 | Dan Smith | |
| 30 | 32 | Alexandre J. Raymond | 1. Start CHIRP |
| 31 | 9 | Dan Smith | 2. Reproduce the failure or bug |
| 32 | 32 | Alexandre J. Raymond | 3. Copy and send the debug log before starting CHIRP again |
| 33 | 9 | Dan Smith | |
| 34 | 29 | Dan Smith | ### Modern CHIRP |
| 35 | |||
| 36 | 24 | 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. |
| 37 | 1 | Dan Smith | |
| 38 | 29 | Dan Smith | <img src="Screenshot 2024-03-04 at 3.37.10 PM.png" height="300"/> |
| 39 | 9 | Dan Smith | |
| 40 | 28 | Dan Smith | Here are some tips for getting the **legacy** CHIRP `debug.log` on the various platforms: |
| 41 | 1 | Dan Smith | |
| 42 | 28 | Dan Smith | ### CHIRP-legacy on Windows |
| 43 | |||
| 44 | 20 | 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. |
| 45 | 1 | Dan Smith | |
| 46 | 28 | Dan Smith | ### CHIRP-legacy on Linux and MacOS |
| 47 | 6 | Dan Smith | |
| 48 | 21 | Dan Smith | Your debug log should be in your home directory, in `.chirp/debug.log`. |
| 49 | 1 | Dan Smith | If you don't know how to find this, open up a terminal window. |
| 50 | 17 | Dan Smith | (Mac: click on spotlight (the magnifying glass icon at top right corner), and type `terminal`) |
| 51 | 11 | Jens Jensen | |
| 52 | 15 | Jens Jensen | Run the following command at the prompt: |
| 53 | 11 | Jens Jensen | |
| 54 | 17 | Dan Smith | ``` |
| 55 | cp ~/.chirp/debug.log ~/Desktop |
||
| 56 | ``` |
||
| 57 | 9 | Dan Smith | |
| 58 | 21 | Dan Smith | Then close the terminal window. The `debug.log` file will be on your desktop. |
| 59 | 7 | Dan Smith | |
| 60 | 17 | Dan Smith | ## Filing your report |
| 61 | 7 | Dan Smith | |
| 62 | 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. |
| 63 | 26 | Dan Smith | |
| 64 | **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. |
||
| 65 | {{include(IssueInstructions)}} |