Re: [PATCH 2/2] STAGING: COMEDI: Wrap line over 80 characters

[Ian Abbott <abbotti@mev.co.uk>]

On 01/02/16 16:35, Hartley Sweeten wrote:
> On Monday, February 01, 2016 5:26 AM, Ian Abbott wrote:
>> On 01/02/16 01:06, Pablo G. Gallardo wrote:
>>> This patch wraps lines over 80 characters.
>>>
>>> Signed-off-by: Pablo G. Gallardo <gallardo_pablo@hotmail.com>
>>> ---
>>>    drivers/staging/comedi/comedi_pcmcia.h | 3 ++-
>>>    1 file changed, 2 insertions(+), 1 deletion(-)
>>>
>>> diff --git a/drivers/staging/comedi/comedi_pcmcia.h b/drivers/staging/comedi/comedi_pcmcia.h
>>> index 5d3db2b..5a572c2 100644
>>> --- a/drivers/staging/comedi/comedi_pcmcia.h
>>> +++ b/drivers/staging/comedi/comedi_pcmcia.h
>>> @@ -39,7 +39,8 @@ void comedi_pcmcia_driver_unregister(struct comedi_driver *,
>>>    				     struct pcmcia_driver *);
>>>
>>>    /**
>>> - * module_comedi_pcmcia_driver() - Helper macro for registering a comedi PCMCIA driver
>>> + * module_comedi_pcmcia_driver() - Helper macro for registering a comedi
>>> + * PCMCIA driver
>>>     * @__comedi_driver: comedi_driver struct
>>>     * @__pcmcia_driver: pcmcia_driver struct
>>>     *
>
> Doesn't this break the docbook format?

It doesn't break the kernel-doc format: "The short description following 
the subject can span multiple lines and ends with an @argument 
description, an empty line or the end of the comment block."

Some people prefer it on a single line, some people indent the 
continuation line(s), and some people do it without indentation as above.

-- 
-=( Ian Abbott @ MEV Ltd.    E-mail: <abbotti@mev.co.uk> )=-
-=(                          Web: http://www.mev.co.uk/  )=-