2020-12-01 19:41:54

by Sonny Sasaka

[permalink] [raw]
Subject: [PATCH BlueZ] doc: Update battery API doc

---
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


2020-12-01 22:58:45

by bluez.test.bot

[permalink] [raw]
Subject: RE: [BlueZ] doc: Update battery API doc

This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=394187

---Test result---

##############################
Test: CheckPatch - PASS

##############################
Test: CheckGitLint - FAIL
Output:
doc: Update battery API doc
3: B6 Body message is missing


##############################
Test: CheckBuild - PASS

##############################
Test: MakeCheck - PASS



---
Regards,
Linux Bluetooth