[U-Boot] [RFC PATCH 14/44] image: Export fit_conf_get_prop_node()

Marek Vasut
2013-03-18T21:19:49Z

Dear Simon Glass,

> Hi Marek,
>
> On Sat, Jan 5, 2013 at 12:12 AM, Marek Vasut <marex@denx.de> wrote:
> > Dear Simon Glass,
> >
> >> This function will be needed by signature checking code, so export it,
> >> and also add docs.
> >>
> >> Signed-off-by: Simon Glass <sjg@chromium.org>
> >
> > [...]
> >
> >> +/**
> >> + * fit_conf_get_prop_node() - Get node refered to by a configuration
> >> + *
> >> + * The conf@ nodes contain references to other nodes, using properties
> >> + * like 'kernel = "kernel at 1"'. Given such a property name (e.g.
> >> "kernel"), + * return the offset of the node referred to (e.g. offset
> >> of node + * "/images/kernel at 1".
> >> + *
> >> + * @fit: FIT to check
> >> + * @noffset: Offset of conf at xxx node to check
> >> + * @prop_name: Property to read from the conf node
> >
> > This parameter list is swapped with the description.
>
> Sorry, can you please explain that a bit more. I'm not sure what you
> are pointing to.

Tough question, especially if asked after such time ;-) I believe I meant the
form of the comment should be like this:

/*
* foo() - Do baz and bar
* @parm1: Number of sharks with lasers
* @parm2: Make the result even cooler
*
* Long boring description of the function doing baz and bar.
*/

I think it makes more sense to stick the function param explanation just
underneath the function name, no?

> >> + */
> >> +int fit_conf_get_prop_node(const void *fit, int noffset,
> >> + const char *prop_name);
> >> +
> >>
> >> void fit_conf_print(const void *fit, int noffset, const char *p);
> >>
> >> int fit_check_ramdisk(const void *fit, int os_noffset,
> >
> > Best regards,
> > Marek Vasut
>
> Regards,
> Simon

Best regards,
Marek Vasut