Hi Patrick,
On Tue, Aug 21, 2012 at 10:31 AM, Patrick Ohly <patrick.ohly@xxxxxxxxx> wrote:
> On Tue, 2012-08-21 at 09:23 +0200, Mikel Astiz wrote:
>> From: Mikel Astiz <mikel.astiz@xxxxxxxxxxxx>
>>
>> The client D-Bus documentation should mention that all transfer paths
>> contain a prefix consisting of the path of the session they belong to.
>>
>> This can be conveniently used by clients to install D-Bus signal matches
>> that concentrate on the relevant signals.
>> ---
>> doc/client-api.txt | 2 +-
>> 1 files changed, 1 insertions(+), 1 deletions(-)
>>
>> diff --git a/doc/client-api.txt b/doc/client-api.txt
>> index 839a78c..7ca65cc 100644
>> --- a/doc/client-api.txt
>> +++ b/doc/client-api.txt
>> @@ -466,7 +466,7 @@ Transfer hierarchy
>>
>> Service org.bluez.obex.client
>> Interface org.bluez.obex.Transfer
>> -Object path [variable prefix]/{transfer0,transfer1,...}
>> +Object path [variable prefix]/{session0,session1,...}/{transfer0,...}
>>
>> Methods dict GetProperties()
>
> It would be even better to explicitly mention that the "[variable
> prefix]" here is the same as the "[variable prefix]" in the Session.
This documentation pattern can be widely found in Obexd and Bluez, as
well as oFono. It's implicit that the variable prefix matches in both
cases.
> Or perhaps change it like this?
>
> -Object path [variable prefix]/{transfer0,transfer1,...}
> +Object path [session prefix]/{transfer0,...}
Having said that, I'm not against using this other style. In that case
we would need to change lots of files for consistency.
Cheers,
Mikel
--
To unsubscribe from this list: send the line "unsubscribe linux-bluetooth" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
