Change in vdsm[master]: vdsm_api: Add schema and html doc generator

smizrahi at redhat.com smizrahi at redhat.com
Mon Jul 16 18:17:19 UTC 2012


Saggi Mizrahi has posted comments on this change.

Change subject: vdsm_api: Add schema and html doc generator
......................................................................


Patch Set 1: I would prefer that you didn't submit this

(11 inline comments)

I'm giving -1 because of the ordered dict inclusion.
All other comments you can ignore if you don't feel like fixing them and I'll just send patches for them when this is in.

In any case reviewing this all at once is impossible.

....................................................
File vdsm_api/ordereddict.py
Line 25: class OrderedDict(dict, DictMixin):
What is wrong with
http://docs.python.org/library/collections.html#collections.OrderedDict

....................................................
File vdsm_api/vdsmapi-schema.json
Line 77: # @Global.addNetwork:
deprecated, covered fully by setupNetwork
No need to include API

Line 98: # @Global.delNetwork:
deprecated, covered fully by setupNetwork
No need to include API

Line 120: # @Global.editNetwork:
deprecated, covered fully by setupNetwork
No need to include API

Line 1028: # @serial:             The device serial number
Should be noted that it might return a string that is not the serial if the serial could not be acquired. This string might be different between hosts. Users should not use this field to compare devices from two different hosts.

Line 1030: # @capacity:           The device size (in bytes)
The device logical size.

Line 1042: # @partitioned:        Reports whether the device has been split into partitions
It should be noted that:
* If the value is true the disk is unusable by VDSM.
* if the device has a partition table but no partitions this will be false and the device is still usable by VDSM.

Line 1100: # Check the visibility of block storage devices.
IMHO visibility is not self explanatory. 

"Check if the host is able to access the device." Maybe?

Line 1571: # Get statistics about currently attached storage.
Get statistics and liveness status about currently active storage domains.

Line 1574: # @XXX:  A dictionary of @StorageDomainStats indexed by Storage Domain @UUID
The structure for this is in sp.py getRepoStats()
You can submit it this way and I'll send a patch with missing types if you don't want to start documenting that as well.

Line 2872: # @name:     The desired name for the new Volume Group
Has to be the uuid of the domain you wish to create. I know it's stupid but that is the way it is.

--
To view, visit http://gerrit.ovirt.org/6343
To unsubscribe, visit http://gerrit.ovirt.org/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I703703ba212b7560d1054f32a86ad083ee88c6c8
Gerrit-PatchSet: 1
Gerrit-Project: vdsm
Gerrit-Branch: master
Gerrit-Owner: Adam Litke <agl at us.ibm.com>
Gerrit-Reviewer: Dan Kenigsberg <danken at redhat.com>
Gerrit-Reviewer: Ryan Harper <ryanh at us.ibm.com>
Gerrit-Reviewer: Saggi Mizrahi <smizrahi at redhat.com>
Gerrit-Reviewer: Shu Ming <shuming at linux.vnet.ibm.com>


More information about the vdsm-patches mailing list