From cb2a4767529bccc6f3a5ccd8d56a82130ff37f11 Mon Sep 17 00:00:00 2001
From: Felipe Leme <felipeal@google.com>
Date: Thu, 23 Sep 2021 11:34:49 -0700
Subject: [PATCH] Documented how to use system service dumper.

Test: m services
Bug: 163921395

Change-Id: I87cde223291b1a6a86ba66d391832d8eef95bfa9
---
 .../core/java/com/android/server/Dumpable.java    |  2 ++
 .../java/com/android/server/SystemServer.java     | 15 +++++++++++++++
 2 files changed, 17 insertions(+)

diff --git a/services/core/java/com/android/server/Dumpable.java b/services/core/java/com/android/server/Dumpable.java
index d2bd66f59b625..866f81c1c5c6c 100644
--- a/services/core/java/com/android/server/Dumpable.java
+++ b/services/core/java/com/android/server/Dumpable.java
@@ -21,6 +21,8 @@ import android.util.IndentingPrintWriter;
 
 /**
  * Interface used to dump {@link SystemServer} state that is not associated with any service.
+ *
+ * <p>See {@link SystemServer.SystemServerDumper} for usage example.
  */
 public interface Dumpable {
 
diff --git a/services/java/com/android/server/SystemServer.java b/services/java/com/android/server/SystemServer.java
index aa5b2095b97ce..dae12754904fa 100644
--- a/services/java/com/android/server/SystemServer.java
+++ b/services/java/com/android/server/SystemServer.java
@@ -645,6 +645,21 @@ public final class SystemServer implements Dumpable {
         TimeUtils.formatDuration(mRuntimeStartElapsedTime, pw); pw.println();
     }
 
+    /**
+     * Service used to dump {@link SystemServer} state that is not associated with any service.
+     *
+     * <p>To dump all services:
+     *
+     * <pre><code>adb shell dumpsys system_server_dumper</code></pre>
+     *
+     * <p>To get a list of all services:
+     *
+     * <pre><code>adb shell dumpsys system_server_dumper --list</code></pre>
+     *
+     * <p>To dump a specific service (use {@code --list} above to get service names):
+     *
+     * <pre><code>adb shell dumpsys system_server_dumper --name NAME</code></pre>
+     */
     private final class SystemServerDumper extends Binder {
 
         @GuardedBy("mDumpables")