2013-04-25 07:33:55

by Mikel Astiz

Subject: [PATCH BlueZ v0] doc: Fix optional properties not marked as such

From: Mikel Astiz <[email protected]>

Commit 826023de56896e83f35ae69a73d6a120a2f5b11e made some of the
device's properties optional but the documentation was not updated
accordingly. More specifically, the properties 'Name' and 'UUIDs' won't
be present if the information is not available.
---
doc/device-api.txt | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/device-api.txt b/doc/device-api.txt
index 0f916c7..187f2bf 100644
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -96,7 +96,7 @@ Properties string Address [readonly]

The Bluetooth device address of the remote device.

- string Name [readonly]
+ string Name [readonly, optional]

The Bluetooth remote name. This value can not be
changed. Use the Alias property instead.
@@ -121,7 +121,7 @@ Properties string Address [readonly]

External appearance of device, as found on GAP service.

- array{string} UUIDs [readonly]
+ array{string} UUIDs [readonly, optional]

List of 128-bit UUIDs that represents the available
remote services.
--
1.8.1.4

2013-04-25 07:38:17

by Johan Hedberg

Subject: Re: [PATCH BlueZ v0] doc: Fix optional properties not marked as such

Hi Mikel,

On Thu, Apr 25, 2013, Mikel Astiz wrote:
> Commit 826023de56896e83f35ae69a73d6a120a2f5b11e made some of the
> device's properties optional but the documentation was not updated
> accordingly. More specifically, the properties 'Name' and 'UUIDs' won't
> be present if the information is not available.
> ---
> doc/device-api.txt | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)

Applied. Thanks.

Johan