Change in vdsm[master]: vdsm: added documentation for downloadImage method

nsoffer at redhat.com nsoffer at redhat.com
Tue Mar 3 21:26:40 UTC 2015


Nir Soffer has posted comments on this change.

Change subject: vdsm: added documentation for downloadImage method
......................................................................


Patch Set 4:

(3 comments)

https://gerrit.ovirt.org/#/c/37934/4/client/vdsClient.py
File client/vdsClient.py:

Line 2593:             '<methodArgs> <spUUID> <sdUUID> <imgUUID> [<volUUID>]',
Line 2594:             'Download an image from a remote endpoint using the specified '
Line 2595:             'methodArgs.\n\n'
Line 2596:             '\tArguments:\n'
Line 2597:             '\t    methodArgs:    Python dictionary literal specifying the download method.\n'
Please format this using list of lines as you did in the previous version of the patch. I missed the code handling list of lines in the application. Sorry for the confusion.
Line 2598:             '\t                   The dictionary must be quoted (e.g, \'{"methodArgs": {"url": ...}\')\n'
Line 2599:             '\t                   Keys:\n'
Line 2600:             '\t                   - url:         url of the source image\n'
Line 2601:             '\t                   - headers:     dictionary of headers (optional)\n'


Line 2603:             '\t    spUUID:        The UUID of the Storage Pool associated with the Image\n'
Line 2604:             '\t    sdUUID:        The UUID of the Storage Domain associated with the Image\n'
Line 2605:             '\t    imgUUID:       The UUID of the Image\n'
Line 2606:             '\t    volUUID:       The UUID of the Volume (optional)\n\n'
Line 2607:             '\tExample:\n'
I commented before that the examples section should come last - do you have any reason to keep it here, or you missed my comment?
Line 2608:             '\tvdsClient -s 0 downloadImage \ \n'
Line 2609:             '\t  {"url": "http://example.com/myimage", "headers": {"Foo": "Bar"}, "method": "http"} \ \n'
Line 2610:             '\t  spUUID sdUUID imgUUID\n\n'
Line 2611:             '\tReturns:\n'


Line 2608:             '\tvdsClient -s 0 downloadImage \ \n'
Line 2609:             '\t  {"url": "http://example.com/myimage", "headers": {"Foo": "Bar"}, "method": "http"} \ \n'
Line 2610:             '\t  spUUID sdUUID imgUUID\n\n'
Line 2611:             '\tReturns:\n'
Line 2612:             '\tA task UUID'
To evaluate this code, we must see the result - I can checkout this patch, build and install this version, and run vdsClient, but it would be nice if you copy and paste the output here (as comment on the patch) instead.

Here is an example:
https://gerrit.ovirt.org/#/c/37494/
Check the Simone comment on Feb 9 3:49 PM.
Line 2613:         )),
Line 2614:         'prepareImage': (serv.prepareImage, (
Line 2615:             '<spUUID> <sdUUID> <imgUUID> [<volUUID>]',
Line 2616:             'Prepare an image, making the needed volumes available.'


-- 
To view, visit https://gerrit.ovirt.org/37934
To unsubscribe, visit https://gerrit.ovirt.org/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: Icb26a36734e2381473aee81614c924c3f285e86c
Gerrit-PatchSet: 4
Gerrit-Project: vdsm
Gerrit-Branch: master
Gerrit-Owner: Candace Sheremeta <cshereme at redhat.com>
Gerrit-Reviewer: Adam Litke <alitke at redhat.com>
Gerrit-Reviewer: Ala Hino <ahino at redhat.com>
Gerrit-Reviewer: Amit Aviram <aaviram at redhat.com>
Gerrit-Reviewer: Candace Sheremeta <cshereme at redhat.com>
Gerrit-Reviewer: Daniel Erez <derez at redhat.com>
Gerrit-Reviewer: Federico Simoncelli <fsimonce at redhat.com>
Gerrit-Reviewer: Greg Padgett <gpadgett at redhat.com>
Gerrit-Reviewer: Idan Shaby <ishaby at redhat.com>
Gerrit-Reviewer: Liron Aravot <laravot at redhat.com>
Gerrit-Reviewer: Maor Lipchuk <mlipchuk at redhat.com>
Gerrit-Reviewer: Nir Soffer <nsoffer at redhat.com>
Gerrit-Reviewer: Tal Nisan <tnisan at redhat.com>
Gerrit-Reviewer: Vered Volansky <vvolansk at redhat.com>
Gerrit-Reviewer: automation at ovirt.org
Gerrit-Reviewer: oVirt Jenkins CI Server
Gerrit-HasComments: Yes


More information about the vdsm-patches mailing list