linux-kernel - Re: Correct place to put the new doc for "How to use this driver"

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20200415163851.2e5f96f8@coco.lan>
Date:   Wed, 15 Apr 2020 16:38:51 +0200
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     rishi gupta <gupt21@...il.com>
Cc:     linux-doc@...r.kernel.org, corbet@....net,
        lkml <linux-kernel@...r.kernel.org>
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 <gupt21@...il.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