lkml.org 
[lkml]   [2019]   [Nov]   [13]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH][RESEND] docs: filesystems: sysfs: convert sysfs.txt to reST
From
Date
On Tue, 2019-11-12 at 10:04 -0700, Jonathan Corbet wrote:
> On Sat, 09 Nov 2019 18:36:16 +0530
> Jaskaran Singh <jaskaransingh7654321@gmail.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

Hopefully I can get the kernel-doc comments right. If not, I'll go with
the alternative :)

Cheers,
Jaskaran.

\
 
 \ /
  Last update: 2019-11-13 08:31    [W:0.046 / U:0.064 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site