From: Mikel Astiz <mikel.astiz.oss@gmail.com>
To: linux-bluetooth@vger.kernel.org
Cc: Mikel Astiz <mikel.astiz@bmw-carit.de>
Subject: [PATCH BlueZ v0] doc: Fix optional properties not marked as such
Date: Thu, 25 Apr 2013 09:33:55 +0200 [thread overview]
Message-ID: <1366875235-12077-1-git-send-email-mikel.astiz.oss@gmail.com> (raw)
From: Mikel Astiz <mikel.astiz@bmw-carit.de>
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
next reply other threads:[~2013-04-25 7:33 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-04-25 7:33 Mikel Astiz [this message]
2013-04-25 7:38 ` [PATCH BlueZ v0] doc: Fix optional properties not marked as such Johan Hedberg
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1366875235-12077-1-git-send-email-mikel.astiz.oss@gmail.com \
--to=mikel.astiz.oss@gmail.com \
--cc=linux-bluetooth@vger.kernel.org \
--cc=mikel.astiz@bmw-carit.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox