self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-01-11 18:24:43 +02:00
Code Issues Releases Activity

Doc: Update debugging.md (#10329)

Browse Source
This commit is contained in:
Akira Taguchi 2024-04-20 15:51:22 +03:00 committed by GitHub
parent 294cc4a440
commit 6358c39810
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
readme/apps/debugging.md
View File

@ -8,10 +8,10 @@ If the application starts with a white screen, open **Help > Toggle Developme
Otherwise, follow these instructions: Otherwise, follow these instructions:
- Click on menu **Help > Open Profile Directory** and add a file named "flags.txt" in your directory with the following content: `--open-dev-tools --debug --log-level debug` 1. Click on menu **Help > Open Profile Directory** and add a file named "flags.txt" in your directory with the following content: `--open-dev-tools --debug --log-level debug`
- Restart the application 2. Restart the application
- The development tools should now be opened. Click the "Console" tab 3. The development tools should now be opened. Click the "Console" tab
- Now repeat the action that was causing problem. The console might output warnings or errors - please add them to the GitHub issue. Also open log.txt in the config folder and if there is any error or warning, please also add them to the issue. 4. Now repeat the action that was causing problem. The console might output warnings or errors - please add them to the GitHub issue. Also open log.txt in the config folder and if there is any error or warning, please also add them to the issue.
Make sure you disable debugging once you've finished. Leaving it enabled can cause your log.txt to grow very quickly. To disable debugging, simply delete the "flags.txt" file created. Make sure you disable debugging once you've finished. Leaving it enabled can cause your log.txt to grow very quickly. To disable debugging, simply delete the "flags.txt" file created.
@ -25,19 +25,19 @@ Safe mode is a special mode that disables all plugins and renders the notes as p
There's two ways to start in safe mode: There's two ways to start in safe mode:
1. From the app, click on **Help > Toggle safe mode**. The app will restart in safe mode. - From the app, click on **Help > Toggle safe mode**. The app will restart in safe mode.
2. If that doesn't work, if for example the app freezes before you can access this menu, you can set a debug flag in "flags.txt" file, [as described above](#desktop-application). Simply set the content to `--safe-mode --open-dev-tools --debug --log-level debug`. - If that doesn't work, if for example the app freezes before you can access this menu, you can set a debug flag in "flags.txt" file, [as described above](#desktop-application). Simply set the content to `--safe-mode --open-dev-tools --debug --log-level debug`.
## CLI application ## CLI application
- Start the app with `joplin --debug --log-level debug` 1. Start the app with `joplin --debug --log-level debug`
- Check log.txt as specified above for the desktop application and attach the log to the GitHub issue (or just the warnings/errors if any). The profile directory would be in `~/.config/joplin`. 2. Check log.txt as specified above for the desktop application and attach the log to the GitHub issue (or just the warnings/errors if any). The profile directory would be in `~/.config/joplin`.
## Mobile application ## Mobile application
- In the [Configuration screen](https://github.com/laurent22/joplin/blob/dev/readme/apps/config_screen.md), press on the **Log button**, and from the options menu, press "share". 1. In the [Configuration screen](https://github.com/laurent22/joplin/blob/dev/readme/apps/config_screen.md), press on the **Log button**, and from the options menu, press "share".
- Attach the shared log (or just relevant portions) to the GitHub issue. 2. Attach the shared log (or just relevant portions) to the GitHub issue.
If you recently (within two weeks) upgraded from 12.11.x to version 12.12.x, [be sure to check the log for and remove any sensitive data shared with Joplin](https://github.com/laurent22/joplin/issues/8211). If you recently (within two weeks) upgraded from 12.11.x to version 12.12.x, [be sure to check the log for and remove any sensitive data shared with Joplin](https://github.com/laurent22/joplin/issues/8211).
@ -47,9 +47,9 @@ https://developer.android.com/studio/debug/bug-report
To get a bug report directly from your device, do the following: To get a bug report directly from your device, do the following:
- Be sure you have [Developer Options](https://developer.android.com/studio/debug/dev-options) enabled. 1. Be sure you have [Developer Options](https://developer.android.com/studio/debug/dev-options) enabled.
- In Developer options, tap Take bug report. 2. In Developer options, tap Take bug report.
- Select the type of bug report you want and tap Report. 3. Select the type of bug report you want and tap Report.
After a moment you get a notification that the bug report is ready. To share the bug report, tap the notification. After a moment you get a notification that the bug report is ready. To share the bug report, tap the notification.