From 5e8d9a024ef2e6315b5f2ce76c85b02f1efbc24a Mon Sep 17 00:00:00 2001 From: Rich Slogar Date: Wed, 5 Nov 2014 13:28:24 -0800 Subject: [PATCH] docs: tools help update [CP] Change-Id: Ida8d313e0439c64fd3f272513d053f44701e22be (cherry picked from commit b858db5ba746c370424028814a20c8902e678433) --- docs/html/tools/help/index.jd | 174 +++++++++++++++++++++++++++++++------- docs/html/tools/help/layoutopt.jd | 4 + 2 files changed, 146 insertions(+), 32 deletions(-) diff --git a/docs/html/tools/help/index.jd b/docs/html/tools/help/index.jd index bed14d187672..75324b79aa42 100644 --- a/docs/html/tools/help/index.jd +++ b/docs/html/tools/help/index.jd @@ -8,6 +8,7 @@ and platform tools. SDK tools are platform independent and are required no matte Android platform you are developing on. Platform tools are customized to support the features of the latest Android platform.

+

SDK Tools

The SDK tools are installed with the SDK starter package and are periodically updated. The SDK tools are required if you are developing Android applications. The most important SDK tools @@ -15,58 +16,158 @@ include the Android SDK Manager (android sdk), the AVD Manager () the emulator (emulator), and the Dalvik Debug Monitor Server (ddms). A short summary of some frequently-used SDK tools is provided below.

+ + +

Virtual Device Tools

+
+ +
Android Virtual Device Manager
+
The AVD Manager provides a graphical user interface in which you can create + and manage Android Virtual Devices (AVDs) that run in the Android Emulator.
+ +
Android Emulator (emulator)
+
A QEMU-based device-emulation tool that you can use to debug and test + your applications in an actual Android run-time environment.
+ +
mksdcard
+
Helps you create a disk image that you can use with the emulator, to simulate the presence + of an external storage card (such as an SD card).
+ +
+ + + + +

Development Tools

-
android
+
android
Lets you manage AVDs, projects, and the installed components of the SDK.
+ +
Hierarchy Viewer (hierarchyviewer)
+
Provides a visual representation of the layout's View hierarchy with performance information + for each node in the layout, and a magnified view of the display to closely examine the + pixels in your layout.
+ +
lint
+
The Android {@code lint} tool is a static code analysis tool that checks your Android + project source files for potential bugs and optimization improvements.
+ +
SDK Manager
+
Lets you manage SDK packages, such as installed platforms and system images.
+ +
sqlite3
+
Lets you access the SQLite data files created and used by Android applications.
+ +
+ + + +

Debugging Tools

+
+ +
adb
+
Android Debug Bridge (adb) is a versatile command line tool that lets you communicate with + an emulator instance or connected Android-powered device. It also provides access to the + device shell for advanced command-line operations.
+ +
uiautomator
+
The {@code uiautomator} testing framework lets you test your user interface (UI) efficiently + by creating automated functional UI testcases that can be run against your app on one or + more devices.
+
Dalvik Debug Monitor Server (ddms)
Lets you debug Android applications.
-
dmtracedump
+ +
Device Monitor
+
Android Device Monitor is a stand-alone tool that provides a graphical user interface for + several Android application debugging and analysis tools.
+ +
dmtracedump
Generates graphical call-stack diagrams from trace log files. The tool uses the Graphviz Dot utility to create the graphical output, so you need to install Graphviz before running dmtracedump. For more information on using dmtracedump, see Profiling with Traceview and dmtracedump
-
Draw 9-patch
-
Allows you to easily create a {@link android.graphics.NinePatch} graphic using a -WYSIWYG editor. It also previews stretched versions of the image, and highlights the area in which -content is allowed.
-
Android Emulator (emulator)
-
A QEMU-based device-emulation tool that you can use to design, debug, and test -your applications in an actual Android run-time environment.
-
Hierarchy Viewer (hierarchyviewer)
-
Lets you debug and optimize an Android application's user interface.
-
hprof-conv
+ + +
hprof-conv
Converts the HPROF file that is generated by the Android SDK tools to a standard format so you can view the file in a profiling tool of your choice.
-
layoutopt
-
Lets you quickly analyze your application's layouts in order to optimize them for -efficiency.
-
mksdcard
-
Helps you create a disk image that you can use with the emulator, to simulate the presence -of an external storage card (such as an SD card).
-
Monkey
+ + +
Monkey
Runs on your emulator or device and generates pseudo-random streams of user events such as clicks, touches, or gestures, as well as a number of system-level events. You can use the Monkey -to stress-test applications that you are developing, in a random yet repeatable manner.
-
monkeyrunner
+to stress-test applications that you are developing, in a random yet repeatable manner. + + + +
monkeyrunner
Provides an API for writing programs that control an Android device or emulator from outside of Android code.
-
ProGuard
-
Shrinks, optimizes, and obfuscates your code by removing unused code and renaming -classes, fields, and methods with semantically obscure names.
-
Systrace
+ +
Systrace
Lets you analyze the execution of your application in the context of system processes, to help diagnose display and performance issues.
-
sqlite3
-
Lets you access the SQLite data files created and used by Android applications.
-
traceview
+ +
traceview
Provides a graphical viewer for execution logs saved by your application.
-
zipalign
+ +
Systrace
+
Lets you analyze the execution of your application in the context of system processes, + to help diagnose display and performance issues.
+ +
+ + +

Build Tools

+
+ +
JOBB
+
Allows you to build encrypted and unencrypted + APK expansion files in Opaque + Binary Blob (OBB) format.
+ +APK expansion files + +
ProGuard
+
Shrinks, optimizes, and obfuscates your code by removing unused code and renaming +classes, fields, and methods with semantically obscure names.
+ +
zipalign
Optimizes .apk files by ensuring that all uncompressed data starts with a particular alignment relative to the start of the file. This should always be used to align .apk files after they have been signed.
-
+ + + + +

Image Tools

+
+
Draw 9-patch
+
Allows you to easily create a {@link android.graphics.NinePatch} graphic using a +WYSIWYG editor. It also previews stretched versions of the image, and highlights the area in which +content is allowed.
+ +
etc1tool
+
A command line utility that lets you encode PNG images to the ETC1 compression standard and + decode ETC1 compressed images back to PNG.
+ +
Tracer for OpenGL ES
+
Allows you to capture OpenGL ES commands and frame by frame images to help you understand + how your graphics commands are being executed.
+ +
+ +

Platform Tools

@@ -83,5 +184,14 @@ build tools or Android Development Tools (ADT), so you rarely need to invoke the As a general rule, you should rely on the build tools or the ADT plugin to call them as needed.

Note: The Android SDK provides additional shell tools that can -be accessed through adb, such as bmgr and -logcat.

\ No newline at end of file +be accessed through adb, such as bmgr and +logcat.

+
+
bmgr
+
A shell tool you can use to interact with the Backup Manager on Android devices supporting + API Level 8 or greater.
+ +
logcat
+
Provides a mechanism for collecting and viewing system debug output.
+ +
diff --git a/docs/html/tools/help/layoutopt.jd b/docs/html/tools/help/layoutopt.jd index 1308b1e71a72..1a183263f1b9 100644 --- a/docs/html/tools/help/layoutopt.jd +++ b/docs/html/tools/help/layoutopt.jd @@ -3,6 +3,10 @@ parent.title=Tools parent.link=index.html @jd:body + +

Note: The Android layoutopt tool has been replaced by the {@code lint} tool beginning in ADT and SDK Tools revision 16. The {@code lint} tool reports UI layout performance issues in a similar way as layoutopt, and detects additional problems.

+

For more information about using {@code lint}, see Improving Your Code with lint and the lint reference documentation.

+

layoutopt is a command-line tool that helps you optimize the layouts and layout hierarchies of your applications.

-- 2.11.0