Skip to content

Commit 418f14f

Browse files
committed
Added adb section to troubleshooting doc
1 parent 023a3fb commit 418f14f

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

doc/source/troubleshooting.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,28 @@ If you find a bug, you can also post an issue on the
1616
`python-for-android Github page
1717
<https://github.com/kivy/python-for-android>`_.
1818

19+
Debugging on Android
20+
--------------------
21+
22+
When a python-for-android APK doesn't work, often the only indication
23+
that you get is that it closes. It is important to be able to find out
24+
what went wrong.
25+
26+
python-for-android redirects Python's stdout and stderr to the Android
27+
logcat stream. You can see this by enabling developer mode on your
28+
Android device, enabling adb on the device, connecting it to your PC
29+
(you should see a notification that USB debugging is connected) and
30+
running ``adb logcat``. If adb is not in your PATH, you can find it at
31+
``/path/to/Android/SDK/platform-tools/adb``.
32+
33+
Running this command gives a lot of information about what Android is
34+
doing. You can usually see important lines by using logcat's built in
35+
functionality to see only lines with the ``python`` tag (or just
36+
grepping this).
37+
38+
When your app crashes, you'll see the normal Python traceback here, as
39+
well as the output of any print statements etc. that your app
40+
runs. Use these to diagnose the problem just as normal.
1941

2042
Common errors
2143
-------------

0 commit comments

Comments
 (0)