linux-kernel - Re: [PATCH][RESEND] docs: filesystems: sysfs: convert sysfs.txt to reST

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: <20191112100454.3b41f3af@lwn.net>
Date:   Tue, 12 Nov 2019 10:04:54 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Jaskaran Singh <jaskaransingh7654321@...il.com>
Cc:     linux-kernel@...r.kernel.org, mchehab+samsung@...nel.org,
        christian@...uner.io, neilb@...e.com, willy@...radead.org,
        tobin@...nel.org, stefanha@...hat.com, hofrat@...dl.org,
        gregkh@...uxfoundation.org, jeffrey.t.kirsher@...el.com,
        linux-doc@...r.kernel.org, skhan@...uxfoundation.org,
        "linux-kernel-mentees@...ts.linuxfoundation.org" 
        <linux-kernel-mentees@...ts.linuxfoundation.org>
Subject: Re: [PATCH][RESEND] docs: filesystems: sysfs: convert sysfs.txt to
 reST

On Sat, 09 Nov 2019 18:36:16 +0530
Jaskaran Singh <jaskaransingh7654321@...il.com> wrote:

> > At a bare minimum, an effort like this needs to put a big flashing
> > warning
> > at the top of the file.  But it would be soooooo much better to
> > actually
> > update the content as well.
> > 
> > The best way to do that would be to annotate the source with proper
> > kerneldoc comments, then pull them into the documentation rather than
> > repeating the information here.  Is there any chance you might be up
> > for
> > taking on a task like this?
> >   
> 
> 
> Sure! I'll send the documentation patch(es) followed by a v2 for this
> patch.

Great.  As an alternative, if you like, redo the current patch with the
other suggested fixes and a "this is obsolete" warning at the top.  Then,
after the subsequent improvements land, that warning can eventually be
removed again.

Thanks,

jon