mirror
/
transmission
mirror of https://github.com/transmission/transmission
1
0
Fork 0
Code Issues Releases Wiki Activity
transmission/docs/Bug-Submission.md

78 lines
5.6 KiB
Markdown
Raw Permalink Normal View History

Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
# Submitting a bug report #
If you are having trouble with Transmission then the things you should do in order are:
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
1. Make sure you are running the current release
docs: misc fixes (#2683) * docs: update Scripts documentation Fixes #1159 * docs: fix broken Blocklist links Fixes #913. * docs: remove trailing spaces in markdown * docs: remove link to nonexistent FAQ Fixes #1937. * docs: unbreak the building-trqt-on-win link Fixes #1226. TODO: import that file to these docs * docs: add call for PRs
2022-02-22 18:45:30 +00:00
1. Search the documentation
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
1. For a bug, ideally we would like you to check if it still exists in the [nightly build](https://build.transmissionbt.com/).
docs: misc fixes (#2683) * docs: update Scripts documentation Fixes #1159 * docs: fix broken Blocklist links Fixes #913. * docs: remove trailing spaces in markdown * docs: remove link to nonexistent FAQ Fixes #1937. * docs: unbreak the building-trqt-on-win link Fixes #1226. TODO: import that file to these docs * docs: add call for PRs
2022-02-22 18:45:30 +00:00
1. Search the Issue Tracker to see if your concern has already been reported:
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* [All open tickets](https://trac.transmissionbt.com/report/2)
* [Search](https://trac.transmissionbt.com/search)
1. If you _do not_ see a ticket matching your problem or feature
* Read the section below on **Submitting a bug report**
* [Add a new ticket](https://trac.transmissionbt.com/newticket).
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
If you _do_ see an existing ticket, please add a comment there again adding as much information as possible.
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
The more users are interested in a ticket, the higher its priority will be.
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
## Information required in a bug report ##
* State the version of Transmission you are using (e.g. Linux/GTK+ 1.80).
If you are using a GUI version of Transmission, you can find its version in the `About` dialog in the Help menu.
**Do not** say _the latest version_ it's ambiguous.
OS X → macOS (#2986)
2022-04-26 14:11:44 +00:00
* State what operating system and version (e.g. macOS 12.3.1, Ubuntu 22.04, ...)
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* Describe the symptoms in a short yet precise manner.
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
* If the problem is reproducible and you explain how to reproduce it, then it stands a high chance of being addressed.
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
If the problem is intermittent then we still want to know, but if you can not tell us how to reproduce it we cannot easily work on it.
docs: misc fixes (#2683) * docs: update Scripts documentation Fixes #1159 * docs: fix broken Blocklist links Fixes #913. * docs: remove trailing spaces in markdown * docs: remove link to nonexistent FAQ Fixes #1937. * docs: unbreak the building-trqt-on-win link Fixes #1226. TODO: import that file to these docs * docs: add call for PRs
2022-02-22 18:45:30 +00:00
* See if the problem only occurs under certain conditions.
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
E.g.: If you are seeing the bug with 50 torrents running and speed limits turned on, also check if it persists with speed limits turned off.
See if it persists with 1 torrent running. See if it persists after pausing and restarting the torrent, etc.
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
**The more work you do to narrow down the bug, the higher our chance of finding and fixing it.**
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
## Reporting specific types of problems ##
Additional information or steps are required for certain categories of problem:
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
### Slow speeds ###
If you are experiencing slow speeds and you have been through the documentation, then please provide the following information **in addition** to the above:
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
* Do you have any per-torrent or global speed limits set?
* What are your global and per-torrent peer limits?
* How many seeds and peers does the "Peers" tab say there are in the swarm?
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* How long ago does the "Tracker" tab say the last announce and scrape results were obtained?
* In the "Tracker" tab's list of trackers, how many tiers are there, and how many trackers are listed for each tier?
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
* How many peers are you connected to?
* Has your torrent finished downloading?
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* If you are still downloading, do any of the connected peers have a higher "completed" percentage than you?
docs: misc fixes (#2683) * docs: update Scripts documentation Fixes #1159 * docs: fix broken Blocklist links Fixes #913. * docs: remove trailing spaces in markdown * docs: remove link to nonexistent FAQ Fixes #1937. * docs: unbreak the building-trqt-on-win link Fixes #1226. TODO: import that file to these docs * docs: add call for PRs
2022-02-22 18:45:30 +00:00
* Is your incoming peer port open or closed?
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
The "Peers" and "Tracker" tabs are in the dialog named "Inspector" on the Mac GUI and "Torrent Properties" on the GTK+ GUI.
Rename Mac OS X to macOS (#3362)
2022-06-27 20:28:37 +00:00
### Crash on macOS ###
If you have problems on the macOS version then please do these extra steps:
* Make sure your system is updated to the latest version of your operating system.
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* If you are running a nightly build, set the language to English. The localization will sometimes crash the nightly builds until they are updated (right before an official release).
OS X → macOS (#2986)
2022-04-26 14:11:44 +00:00
* macOS collects two pieces of crash information that can help us fix the crash:
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
1. In Console.app, look under LOG FILES > ~/Library/Logs/ > CrashReporter > for Transmission. If you find one, include it in your forum post.
2. In Console.app, select LOG DATABASE QUERIES > Console Messages, and search for Transmission. If you find a message that mentions an assertion failure, include it in your forum post.
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
If the two pieces of information above are too large for your forum post, paste them [here](https://pastebin.com/), choose a paste expiration of one month and click the "Create New Paste" button. Then include the pastebin's URL in your forum post.
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
### Port mapping error ###
docs: convert some wiki markup to markdown (#2692)
2022-02-23 17:00:55 +00:00
Read the [Port Forwarding Guide](Port-Forwarding-Guide.md) first.
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
You then need to include:
Improve the documentation (#2900) * Unify the line endings to the Unix style (LF only). * Fix (where possible) or remove broken links. * Improve the documentation. Fix or remove broken links (depending on whether I could find a working version of the resource). Change all links to use HTTPS instead of HTTP. Unify the capitalizations (e.g. uppercase abbreviations, capitalize proper names and downcase other words). Fix or improve some parts of the text, clarifying what is meant. Improve some parts of the program examples (e.g. only use root privileges where really required).
2022-04-11 17:38:32 +00:00
* What router you are using
* That you have confirmed that either UPnP or NAT-PMP is enabled on it
* If you are using a custom firmware, tell us which one
* Most importantly, post the lines from the message log that contain the phrase "Port Mapping". They will look something like this:
docs: absorb the wiki
2022-02-21 16:39:27 +00:00
docs: convert some wiki markup to markdown (#2692)
2022-02-23 17:00:55 +00:00
```
02:12:27 Port Mapping (NAT-PMP): initnatpmp returned success (0)
02:12:27 Port Mapping (NAT-PMP): sendpublicaddressrequest returned success (2)
02:12:27 Port Mapping: mapping state changed from 'not mapped' to 'mapping'
02:12:27 Port Mapping: opened port 55555 to listen for incoming peer connections
02:12:35 Port Mapping (NAT-PMP): readnatpmpresponseorretry returned error -7, errno is 111 (Connection refused)
02:12:35 Port Mapping (NAT-PMP): If your router supports NAT-PMP, please make sure NAT-PMP is enabled!
02:12:35 Port Mapping (NAT-PMP): NAT-PMP port forwarding unsuccessful, trying UPnP next
02:12:37 Port Mapping (UPNP): Found Internet Gateway Device 'http://192.168.1.1:5431/uuid:0012-17c3-4e400200b4b4/WANIPConnection:1'
02:12:37 Port Mapping (UPNP): Local LAN IP Address is '192.168.1.99'
02:12:37 Port Mapping (UPNP): Port forwarding via 'http://192.168.1.1:5431/uuid:0012-17c3-4e400200b4b4/WANIPConnection:1', service 'urn:schemas-upnp-org:service:WANIPConnection:1'. (local address: 192.168.1.99:55555)
02:12:37 Port Mapping (UPNP): Port forwarding successful!
02:12:37 Port Mapping: mapping state changed from 'mapping' to 'mapped'
```