Updated Report a bug (markdown)

master
Martín Fernández 2 years ago
parent f060b47b69
commit a555bd2b0f

@ -20,39 +20,27 @@ If you have to create a new ticket, please try to keep in mind the following adv
* KOReader version
1. If the bug is related to a **document rendering issue** please provide a **sample document** that shows the bug.
* **document rendering issue**? : attach a **sample document** that shows the bug.
- You can attach the document as is if is not copyrighted.
- You can attach a scrambled copy of the document (link here to how to do that)
- **Extra points** if you create a minimum test case that shows the bug and nothing else.
- You can attach the document as is if it is not copyrighted.
- You can attach a scrambled copy of the document (only for epub)
- **Extra points** if you create a minimum test case that shows the bug and nothing else.
2. If the bug you're reporting is related to a crash or any other issue and you're not 100% sure is device independant you need to attach the **`crash.log`**.
If you have a document that's copyrighted, is not an epub and you don't want to share with us privately you'll need to provide a test case.
Each platform has a different way to retrieve the file:
* **other issue**?: attach the `crash.log`
* **Android**: Go to `Help``Bug Report` to dump logs to file.
* **Desktop**: Run from a terminal emulator and capture the output (ie: `koreader | tee crash.log` or `koreader >crash.log 2>&1`)
* **Embedded**:
2.1 USB mount
| Platform | Method | File |
|---|---|---|
| **Cervantes** | SSH<sub>2</sub> | `/mnt/private/koreader/crash.log` |
| **Kindle** | USB<sub>1</sub> | `koreader/crash.log` |
| **Kobo** | USB<sub>1</sub> | `.adds/koreader/crash.log` |
| **Pocketbook** | USB<sub>1</sub> | `applications/koreader/crash.log` |
| **Remarkable** | SSH<sub>2</sub> | `/opt/koreader/crash.log` |
Connect the device to your computer as an USB share and retrieve the file. Paths are relative to USB mount point.
<sub>1</sub> Connect to computer as an USB share and copy that file.
| Platform | Path |
|---|---|
| **Kobo** | `koreader/crash.log` |
| **Kindle** | `koreader/crash.log` |
| **Pocketbook** | `applications/koreader/crash.log` |
2.2 SSH
Get the file directly from your device using ssh/scpy. Paths are absolute.
| Platform | Path |
|---|---|
| **Kindle** | `/mnt/us/koreader/crash.log` |
| **Cervantes** | `/mnt/private/koreader/crash.log` |
| **Remarkable** | `/opt/koreader/crash.log` |
2.3 Edge cases
**Android**: logs are kept in memory. Please go to Help → Bug Report to save these logs to a file.
**Desktop platforms**: no log is saved by default. You can get one by executing the program from a terminal emulator.
<sub>2</sub> Use `scpy` (or similar Windows app?) to get the log (ie: `scpy root@ip:/path/to/crash.log crash.log`)

Loading…
Cancel
Save