From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: rishi gupta <gupt21@gmail.com>
Cc: linux-doc@vger.kernel.org, corbet@lwn.net,
lkml <linux-kernel@vger.kernel.org>
Subject: Re: Correct place to put the new doc for "How to use this driver"
Date: Wed, 15 Apr 2020 16:38:51 +0200 [thread overview]
Message-ID: <20200415163851.2e5f96f8@coco.lan> (raw)
In-Reply-To: <CALUj-gsRgkEyRe3vubEeWx8ENwEyE+Fzv4bKKDZ+iq3urRG0BA@mail.gmail.com>
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
next prev parent reply other threads:[~2020-04-15 14:39 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
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 [this message]
2020-04-15 14:47 ` rishi gupta
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200415163851.2e5f96f8@coco.lan \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=gupt21@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).