From 6094014487ceb35a72900c073ddd6db2f2244a5a Mon Sep 17 00:00:00 2001
From: akwizgran <michael@briarproject.org>
Date: Thu, 13 Aug 2020 16:23:44 +0100
Subject: [PATCH] Add a comment discouraging use of dedicated threads.

---
 .../bramble/api/system/AndroidWakeLockManager.java             | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/bramble-android/src/main/java/org/briarproject/bramble/api/system/AndroidWakeLockManager.java b/bramble-android/src/main/java/org/briarproject/bramble/api/system/AndroidWakeLockManager.java
index b1cad4377..bd96ef61b 100644
--- a/bramble-android/src/main/java/org/briarproject/bramble/api/system/AndroidWakeLockManager.java
+++ b/bramble-android/src/main/java/org/briarproject/bramble/api/system/AndroidWakeLockManager.java
@@ -30,6 +30,9 @@ public interface AndroidWakeLockManager {
 	 * lock is acquired before starting the thread and released when the task
 	 * completes, or if an exception is thrown while starting the thread or
 	 * running the task.
+	 * <p>
+	 * This method should only be used for lifecycle management tasks that
+	 * can't be run on an executor.
 	 */
 	void executeWakefully(Runnable r, String tag);
 }