linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* Correct place to put the new doc for "How to use this driver"
@ 2020-04-15  3:55 rishi gupta
  2020-04-15 14:38 ` Mauro Carvalho Chehab
  0 siblings, 1 reply; 3+ messages in thread
From: rishi gupta @ 2020-04-15  3:55 UTC (permalink / raw)
  To: linux-doc, corbet; +Cc: lkml

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

^ permalink raw reply	[flat|nested] 3+ messages in thread
* Re: Correct place to put the new doc for "How to use this driver"
  2020-04-15  3:55 Correct place to put the new doc for "How to use this driver" rishi gupta
@ 2020-04-15 14:38 ` Mauro Carvalho Chehab
  2020-04-15 14:47   ` rishi gupta
  0 siblings, 1 reply; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2020-04-15 14:38 UTC (permalink / raw)
  To: rishi gupta; +Cc: linux-doc, corbet, lkml

Em Wed, 15 Apr 2020 09:25:02 +0530
rishi gupta <gupt21@gmail.com> 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

^ permalink raw reply	[flat|nested] 3+ messages in thread
* Re: Correct place to put the new doc for "How to use this driver"
  2020-04-15 14:38 ` Mauro Carvalho Chehab
@ 2020-04-15 14:47   ` rishi gupta
  0 siblings, 0 replies; 3+ messages in thread
From: rishi gupta @ 2020-04-15 14:47 UTC (permalink / raw)
  To: Mauro Carvalho Chehab; +Cc: linux-doc, corbet, lkml

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

On Wed, Apr 15, 2020 at 8:08 PM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> Em Wed, 15 Apr 2020 09:25:02 +0530
> rishi gupta <gupt21@gmail.com> 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

^ permalink raw reply	[flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-04-15 14:47 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-04-15  3:55 Correct place to put the new doc for "How to use this driver" rishi gupta
2020-04-15 14:38 ` Mauro Carvalho Chehab
2020-04-15 14:47   ` rishi gupta

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).