public inbox for linux-bluetooth@vger.kernel.org
 help / color / mirror / Atom feed
From: Paul Fertser <fercerpav@gmail.com>
To: linux-bluetooth@vger.kernel.org
Subject: [PATCH] network-api: improve documentation
Date: Tue, 11 Aug 2009 10:19:13 +0400	[thread overview]
Message-ID: <200908110622.n7B6MsPa013874@home.pavel.comp> (raw)

Information about ways of specifying uuids and about disconnect conditions.

Signed-off-by: Paul Fertser <fercerpav@gmail.com>
---
 doc/network-api.txt |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/doc/network-api.txt b/doc/network-api.txt
index 7271193..d935863 100644
--- a/doc/network-api.txt
+++ b/doc/network-api.txt
@@ -17,6 +17,14 @@ Methods		string Connect(string uuid)
 			device name. Examples of the device name are bnep0,
 			bnep1 etc.
 
+			uuid can be either one of "gn"/"panu"/"nap" (case
+			insensitive) or traditional string representation
+			of uuid or a hexadecimal number.
+
+			The connection will be closed and network device
+			released either upon calling Disconnect() or when
+			the client disappears from the bus.
+
 			Possible errors: org.bluez.Error.AlreadyConnected
 					 org.bluez.Error.ConnectionAttemptFailed
 
-- 
1.6.0.6


             reply	other threads:[~2009-08-11  6:19 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-08-11  6:19 Paul Fertser [this message]
2009-08-11 22:04 ` [PATCH] network-api: improve documentation Marcel Holtmann
2009-08-11  6:19   ` Paul Fertser
2009-08-12 21:57     ` Marcel Holtmann

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=200908110622.n7B6MsPa013874@home.pavel.comp \
    --to=fercerpav@gmail.com \
    --cc=linux-bluetooth@vger.kernel.org \
    /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