Re: [PATCH v4 01/10] battery: Add generic device battery documentation

Hi Chen,

On Sun, Sep 30, 2012, Chen Ganir wrote:

quoted

On Mon, Sep 24, 2012, chen.ganir@ti.com wrote:

quoted

+BlueZ D-Bus Battery API description
+****************************************

Please keep the "underline" consistent with the length of the text above
it.

quoted

+	Texas Instruments, Inc. [off-list ref]

What's this supposed to be? If you want a copyright statement here then
make it of the proper format. Author info is not needed as we have the
AUTHORS file and the commit history.

Would you please specify what is the proper copyright message format
? doc/adapter-api.txt, doc/health-api.txt have two different styles.
doc/oob-api.txt has a third style (AUTHOR <author@email> for
COMPANY),
doc/media-api.txt for example does not have any copyright
information. In addition - you say author information is not
required, yet all other copyright messages contain this. Is this a
new policy ? If so, please specify the proper copyright message.

How about git grep "Texas Instruments"? None of the entries contain
author information so your assertion makes it look like you didn't
really dig too deep. The policy has always been to keep author info in
AUTHORS and the commit history and have copyright statements only for
the sake of copyright information. Exceptions do of course slip through
as the maintainers are humans and not robots ;)

Ultimately you need to ask your employer for what kind of copyright
statement you should use, e.g. some prefer to have a "All rights
reserved" at the end whereas others don't care.

quoted

quoted

+		array{object} Batteries [readonly]

I guess you should mark this with [experimental] since it'll be removed
with the advent of ObjectManager.

What is the difference between the Batteries property and the
services or UUIDs property in device-api.txt ? Should all of them
get marked with experimental ?

The Services property will probably be removed for 5.0 but the UUIDs
will stay (not sure why you brought it up anyway?). Just mark this new
property as experimental since it'll likely be gone by the time 5.0 goes
out.

Johan