Re: [Xen-devel] [OSSTEST Nested PATCH v11 4/7] Changes on test step of Debian hvm guest install

[Ian Jackson <Ian.Jackson@xxxxxxxxxxxxx>]

Pang, LongtaoX writes ("RE: [OSSTEST Nested PATCH v11 4/7] Changes on test step 
of Debian hvm guest install"):
> [Ian Jackson:]
> > longtao.pang writes ("[OSSTEST Nested PATCH v11 4/7] Changes on test step of
> > > +    # Use guest_var to get specific disk size, or will use default 
> > > $disk_mb
> > > +    $disk_mb= guest_var($gho,'disksize',$disk_mb);
> > 
> > I would prefer this comment and the one about RAM to be expressed,
> > instead, like this:
> > 
> >     sub more_prepareguest_hvm ($$$$;@) {
> >         my ($ho, $gho, $ram_mb, $disk_mb, %xopts) = @_;
> >   +     # $ram_mb and $disk_mb are defaults, used if runvars don't say
> > 
> I am sorry, do you mean that I should add another more comment you preferred 
> in 'more_prepareguest_hvm ($$$$;@)' function inside TestSupport.pm?

I mean that you should add this comment instead of the ones next to
the assignments to $disk_mb and $ram_mb.

Interface comments (which in this case document a non-obvious feature
of the function's behaviour) are much better than code comments (which
in this case would simply say the same thing as the code).

Ian.

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel