aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPo Lu2023-02-19 20:16:32 +0800
committerPo Lu2023-02-19 20:16:32 +0800
commit47dbdb06dc4a4ec4926e5bb298f12452575bcb59 (patch)
treec7d081dd4368bb2c82d5d9120e7427044f1a311a
parent0998ab3ade7caf2b163cd99a44b8a3f17be763d5 (diff)
downloademacs-47dbdb06dc4a4ec4926e5bb298f12452575bcb59.tar.gz
emacs-47dbdb06dc4a4ec4926e5bb298f12452575bcb59.zip
Improve Android documentation
* INSTALL.android: Say where building Emacs is supported. * doc/emacs/android.texi (Android Startup): Describe how to connect via ADB.
-rw-r--r--INSTALL.android5
-rw-r--r--doc/emacs/android.texi38
2 files changed, 39 insertions, 4 deletions
diff --git a/INSTALL.android b/INSTALL.android
index 442bfef6422..24877d88aef 100644
--- a/INSTALL.android
+++ b/INSTALL.android
@@ -14,7 +14,7 @@ Android is an unusual operating system in that program binaries cannot
14be produced on computers running Android themselves. Instead, they 14be produced on computers running Android themselves. Instead, they
15must be built on some other computer using a set of tools known as the 15must be built on some other computer using a set of tools known as the
16``Android SDK'' (Software Development Kit) and the ``Android NDK'' 16``Android SDK'' (Software Development Kit) and the ``Android NDK''
17(Native Development Kit). Appropriate versions of both must be 17(Native Development Kit.) Appropriate versions of both must be
18obtained to build GNU Emacs; after being built, the generated binaries 18obtained to build GNU Emacs; after being built, the generated binaries
19will work on almost all Android devices. This document does not 19will work on almost all Android devices. This document does not
20elaborate on how both sets of tools can be obtained. However, for 20elaborate on how both sets of tools can be obtained. However, for
@@ -23,6 +23,9 @@ Debian project.
23 23
24In addition to the Android SDK and Android NDK, Emacs also requires 24In addition to the Android SDK and Android NDK, Emacs also requires
25the Java compiler from OpenJDK 1.7.0 to be installed on your system. 25the Java compiler from OpenJDK 1.7.0 to be installed on your system.
26Building on GNU systems is all that is officially supported. We are
27told that Mac OS works too, and other Unix systems will likely work
28as well, but MS Windows and Cygwin will not.
26 29
27Once all of those tools are obtained, you may invoke the `configure' 30Once all of those tools are obtained, you may invoke the `configure'
28script like so: 31script like so:
diff --git a/doc/emacs/android.texi b/doc/emacs/android.texi
index 4e5402f5f40..4feb3f0c3ef 100644
--- a/doc/emacs/android.texi
+++ b/doc/emacs/android.texi
@@ -72,11 +72,11 @@ application icon is clicked.
72 72
73 During startup, Emacs will display messages in the system log 73 During startup, Emacs will display messages in the system log
74buffer; reading that buffer requires the Android Debug Bridge 74buffer; reading that buffer requires the Android Debug Bridge
75(@code{adb}) utility to be installed on another computer; it cannot be 75(@command{adb}) utility to be installed on another computer; it cannot
76read on the computer running Android itself. 76be read on the computer running Android itself.
77 77
78 After enabling the ``USB Debugging'' feature on the Android system, 78 After enabling the ``USB Debugging'' feature on the Android system,
79and connecting it via USB to another system with the @code{adb} 79and connecting it via USB to another system with the @command{adb}
80utility installed, the log can be viewed by running the following 80utility installed, the log can be viewed by running the following
81command on that other system: 81command on that other system:
82 82
@@ -84,6 +84,38 @@ command on that other system:
84$ adb logcat | grep -E "(android_run_debug_thread|[Ee]macs)" 84$ adb logcat | grep -E "(android_run_debug_thread|[Ee]macs)"
85@end example 85@end example
86 86
87 Assuming that the @command{adb} utility is installed on a GNU/Linux
88or Unix system, follow the steps below to connect to your device.
89
90@enumerate
91@item
92Enable ``developer options'' on your device, by going to the ``About''
93page in the system settings application and clicking on the ``build
94version'' or ``kernel version'' items five to seven times.
95
96@item
97Turn on the switch ``USB debugging''.
98
99@item
100Connect one end of a USB cable to your device, and the other end to
101your computer's USB port.
102
103@item
104Run the command @command{adb shell} on your computer. This will fail
105or hang because you have not yet granted your computer permission to
106access the connected device.
107
108@item
109Confirm the pop-up displayed on your device asking whether or not it
110should allow access from your computer.
111@end enumerate
112
113 Depending on the versions of Android and @command{adb} installed,
114there may be other ways to establish a connection. See the official
115documentation at
116@url{https://developer.android.com/studio/command-line/adb} for more
117details.
118
87@cindex emacsclient wrapper, android 119@cindex emacsclient wrapper, android
88 Since there is no other way to start the @command{emacsclient} 120 Since there is no other way to start the @command{emacsclient}
89program (@pxref{Emacs Server}) from another Android program, Emacs 121program (@pxref{Emacs Server}) from another Android program, Emacs