On Wed, Feb 05, 2014 at 11:23:52AM +0100, Santi Raffa wrote:
> On Wed, Feb 5, 2014 at 11:01 AM, Jose A. Lopes <[email protected]> wrote:
> >   "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?
> 
> Yes.
> 
> >  Why are the parameters temporary?
> 
> They are not saved to the configuration file.
> 
> > What does it mean to override the configuration? Instance configuration? Or
> > cluster configuration?
> 
> IIRC, the combination of both.
> 
> >   "Tuple containing the target instance and the OS parameters"
> 
> That would not be correct. If the second argument is empty, the RPC
> will still use the parameters from the configuration.
> 
> >
> > 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.
> 
> I'd already done this, but it's changed later in the patch series
> (gah!). I've removed that change from that commit and applied it to
> this one.
> 
> I'm also okay with dropping this commit if you think it's confusing
> more than it helps. Piecing together the information to understand
> this type required me to look in about eight different places in the
> source code, but maybe it's more obvious to brighter minds than
> mine...

This commit is very important. Don't drop it.

Just make sure it is understandable also by people who didn't do the
reasearch you did to figure what those parameters where doing.  That's all :)

> As for the commit message:
> 
> commit 84121cd79a7d331d854c933e2bfd74faf094b955
> Author: Santi Raffa <[email protected]>
> Date:   Wed Jan 22 14:33:55 2014 +0100
> 
>     RPCs: add docstrings for instance_os_add
> 
>     This RPC's instance_osp input has a non-obvious, non documented
>     type. This patch adds documentation to this RPC.
> 
> -- 
> Raffa Santi
> 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

-- 
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

Reply via email to