Received-SPF: pass (google.com: domain of linux-bluetooth-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Sonny Sasaka <sonnysasaka@chromium.org>
To:     linux-bluetooth@vger.kernel.org
Cc:     Sonny Sasaka <sonnysasaka@chromium.org>
Subject: [PATCH BlueZ] doc: Update battery API doc
Date:   Tue,  1 Dec 2020 11:40:21 -0800
Message-Id: <20201201194021.341363-1-sonnysasaka@chromium.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

---
 doc/battery-api.txt | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/doc/battery-api.txt b/doc/battery-api.txt
index 9a6b4fd39..ec7d593da 100644
--- a/doc/battery-api.txt
+++ b/doc/battery-api.txt
@@ -15,12 +15,10 @@ Properties	byte Percentage [readonly]
 
 		string Source [readonly, optional, experimental]
 
-			Describes where the battery information comes from
-			This property is informational only and may be useful
-			for debugging purposes.
-			Providers from BatteryProvider1 may make use of this
-			property to indicate where the battery report comes from
-			(e.g. "HFP 1.7", "HID", or the profile UUID).
+			Describes where the battery information comes from.
+			Providers may provide the source information in the form
+			of the profile UUID where the battery information is
+			reported.
 
 
 Battery Provider Manager hierarchy
@@ -61,8 +59,8 @@ Object path	{provider_root}/{unique battery object path}
 
 Properties	Objects provided on this interface contain the same properties
 		as org.bluez.Battery1 interface. Additionally, this interface
-		needs to have the Device property indicating the object path
-		of the device this battery provides.
+		needs to have a Device property indicating the object path the
+		battery information is provided for.
 
 		object Device [readonly]
 
-- 
2.26.2