2020-04-15 15:03:22

by rishi gupta

Subject: Correct place to put the new doc for "How to use this driver"

Hi Team,

I need to add a documentation file to let users know "how to use this driver".
Specifically this one (tty-ttyvs.rst): https://lkml.org/lkml/2020/2/15/153

(1) I am unable to find any directory where it will fit. This driver
belongs to Virtual TTY device category.
Any suggestions where to put it?

(2) After putting it is it mandatory to link it to
Documentation/index.rst as suggested here
https://www.kernel.org/doc/html/latest/doc-guide/index.html

Regards,
Rishi

2020-04-16 00:10:17

by Mauro Carvalho Chehab

Subject: Re: Correct place to put the new doc for "How to use this driver"

Em Wed, 15 Apr 2020 09:25:02 +0530
rishi gupta <[email protected]> escreveu:

> Hi Team,
>
> I need to add a documentation file to let users know "how to use this driver".
> Specifically this one (tty-ttyvs.rst): https://lkml.org/lkml/2020/2/15/153
>
> (1) I am unable to find any directory where it will fit. This driver
> belongs to Virtual TTY device category.
> Any suggestions where to put it?

Docs focused on driver usage belongs to the admin-guide.

>
> (2) After putting it is it mandatory to link it to
> Documentation/index.rst as suggested here
> https://www.kernel.org/doc/html/latest/doc-guide/index.html

You should actually add it to Documentation/admin-guide/index.rst.

>
> Regards,
> Rishi



Thanks,
Mauro

2020-04-16 00:13:45

by rishi gupta

Subject: Re: Correct place to put the new doc for "How to use this driver"

Thanks Mauro. I will put doc in admin-guide folder.

On Wed, Apr 15, 2020 at 8:08 PM Mauro Carvalho Chehab
<[email protected]> wrote:
>
> Em Wed, 15 Apr 2020 09:25:02 +0530
> rishi gupta <[email protected]> escreveu:
>
> > Hi Team,
> >
> > I need to add a documentation file to let users know "how to use this driver".
> > Specifically this one (tty-ttyvs.rst): https://lkml.org/lkml/2020/2/15/153
> >
> > (1) I am unable to find any directory where it will fit. This driver
> > belongs to Virtual TTY device category.
> > Any suggestions where to put it?
>
> Docs focused on driver usage belongs to the admin-guide.
>
> >
> > (2) After putting it is it mandatory to link it to
> > Documentation/index.rst as suggested here
> > https://www.kernel.org/doc/html/latest/doc-guide/index.html
>
> You should actually add it to Documentation/admin-guide/index.rst.
>
> >
> > Regards,
> > Rishi
>
>
>
> Thanks,
> Mauro