Re: [PATCH] irqdomain: Add documentation for irq_create_of_mapping()

From: Kari Argillander
Date: Tue Dec 15 2020 - 15:41:48 EST


On Tue, Dec 15, 2020 at 09:07:47PM +0100, Christophe JAILLET wrote:
> +++ b/kernel/irq/irqdomain.c
> @@ -858,6 +858,15 @@ unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec)
> }
> EXPORT_SYMBOL_GPL(irq_create_fwspec_mapping)
> +/**
> + * irq_create_of_mapping() - Map an interrupt
> + * @irq_data: structure of_phandle_args returned by a previous
> + * of_irq_parse_xxx() call

Start with upper case and use periods. Also next line should align.

> + *
> + * The resources allocated by this function should be freed by
> + * calling irq_dispose_mapping() when the mapping if not useful
> + * anymore.
> + */

Maybe "mapping is not" or "if the mappign is not". There could be lot
better wording formatting also but everyone would still understand. So
it is ok.