Re: [Linux-kernel-mentees] [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST

[Jonathan Corbet <corbet@lwn.net>]

On Tue, 18 Jun 2019 07:41:58 +0200
Greg KH <gregkh@linuxfoundation.org> wrote:

> On Tue, Jun 18, 2019 at 11:02:27AM +0530, Puranjay Mohan wrote:
> > This converts the plain text documentation to reStructuredText format.
> > No essential content change.
> > 
> > Signed-off-by: Puranjay Mohan <puranjay12@gmail.com>
> > ---
> >  Documentation/platform/x86-laptop-drivers.rst | 23 +++++++++++++++++++
> >  Documentation/platform/x86-laptop-drivers.txt | 18 ---------------
> >  2 files changed, 23 insertions(+), 18 deletions(-)
> >  create mode 100644 Documentation/platform/x86-laptop-drivers.rst
> >  delete mode 100644 Documentation/platform/x86-laptop-drivers.txt  
> 
> Don't you also need to hook it up to the documentation build process
> when doing this?

Hooking it into the TOC tree is a good thing, but I think it's also good
to think about the exercise in general.  This is a document dropped into
place five years ago and never touched again.  It's a short list of
seemingly ancient laptops with no explanation of what it means.  So the
real question, IMO, is whether this document is useful to anybody and, if
not, whether it should just be deleted instead.

Puranjay, thanks for working to improve the kernel docs!  Please don't be
discouraged by this response - it's just a sign that kernel documentation
has problems far beyond just formatting...

Thanks,

jon