[PATCH] network-api: improve documentation

[PATCH] network-api: improve documentation

[Paul Fertser]

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

Re: [PATCH] network-api: improve documentation

[Marcel Holtmann]

Hi Paul,

> Information about ways of specifying uuids and about disconnect conditions.

it is UUIDs and not uuids.

> Signed-off-by: Paul Fertser <fercerpav@gmail.com>

We don't use Signed-off-by for BlueZ.

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

Write it UUID. And use "gn", "panu" or "nap".

> +			The connection will be closed and network device
> +			released either upon calling Disconnect() or when
> +			the client disappears from the bus.

s/bus/message bus/

Regards

Marcel

[PATCH] network-api: improve documentation

[Paul Fertser]

Information about ways of specifying UUIDs and about disconnect conditions.

---
 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..ae2be4f 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" or "nap" (case
+			insensitive) or a 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 message bus.
+
 			Possible errors: org.bluez.Error.AlreadyConnected
 					 org.bluez.Error.ConnectionAttemptFailed
 
-- 
1.6.0.6

Re: [PATCH] network-api: improve documentation

[Marcel Holtmann]

Hi Paul,

> Information about ways of specifying UUIDs and about disconnect conditions.
> 
> ---
>  doc/network-api.txt |    8 ++++++++
>  1 files changed, 8 insertions(+), 0 deletions(-)

patch has been applied. Thanks.

Regards

Marcel