Title of the patch should be RPCs: fix docstrings for instance_os_add
Patch needs a description as well (apart from the title). On Tue, Feb 04, 2014 at 05:00:20PM +0100, Santi Raffa wrote: > Signed-off-by: Santi Raffa <[email protected]> > --- > lib/rpc_defs.py | 8 +++++--- > 1 file changed, 5 insertions(+), 3 deletions(-) > > diff --git a/lib/rpc_defs.py b/lib/rpc_defs.py > index 6650c43..fbeec1d 100644 > --- a/lib/rpc_defs.py > +++ b/lib/rpc_defs.py > @@ -288,10 +288,12 @@ _INSTANCE_CALLS = [ > ("reason", None, "The reason for the startup"), > ], None, None, "Starts an instance"), > ("instance_os_add", SINGLE, None, constants.RPC_TMO_1DAY, [ > - ("instance_osp", ED_INST_DICT_OSP_DP, None), > - ("reinstall", None, None), > + ("instance_osp", ED_INST_DICT_OSP_DP, "Tuple: target instance," > + " temporary OS parameters" > + " overriding configuration."), Do not include trailing periods to be consistent with the other docstrings. Also, the message "Tuple: target instance, temporary OS parameters overriding configuration." I have no idea what this means. Is it a tuple containing two elements, the name of the target instance and some parameters? Why are the parameters temporary? What does it mean to override the configuration? Instance configuration? Or cluster configuration? I think the user won't understand this. Perhaps the following is enough for the rpc_defs: "Tuple containing the target instance and the OS parameters" and a more detailed description should go elsewhere, maybe the documentation or the manpages. > + ("reinstall", None, "Whether the instance is being reinstalled."), Remove trailing period. Thanks, Jose > ("debug", None, None), > - ], None, None, "Starts an instance"), > + ], None, None, "Installs an OS onto an instance"), > ("hotplug_device", SINGLE, None, constants.RPC_TMO_NORMAL, [ > ("instance", ED_INST_DICT, "Instance object"), > ("action", None, "Hotplug Action"), > -- > 1.9.0.rc1.175.g0b1dcb5 > -- Jose Antonio Lopes Ganeti Engineering Google Germany GmbH Dienerstr. 12, 80331, München Registergericht und -nummer: Hamburg, HRB 86891 Sitz der Gesellschaft: Hamburg Geschäftsführer: Graham Law, Christine Elizabeth Flores Steuernummer: 48/725/00206 Umsatzsteueridentifikationsnummer: DE813741370
