From: Jaskaran Singh <jaskaransingh7654321@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
willy@infradead.org, neilb@suse.com, tobin@kernel.org,
stefanha@redhat.com, hofrat@osadl.org,
mchehab+samsung@kernel.org,
linux-kernel-mentees@lists.linuxfoundation.org,
christian@brauner.io, jeffrey.t.kirsher@intel.com
Subject: Re: [Linux-kernel-mentees] [PATCH][RESEND] docs: filesystems: sysfs: convert sysfs.txt to reST
Date: Wed, 13 Nov 2019 13:00:36 +0530 [thread overview]
Message-ID: <97b1695ebcbd2dd5ce8c117af0232ad6a1fee20f.camel@gmail.com> (raw)
In-Reply-To: <20191112100454.3b41f3af@lwn.net>
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.
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
prev parent reply other threads:[~2019-11-13 7:30 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-05 7:18 [Linux-kernel-mentees] [PATCH][RESEND] docs: filesystems: sysfs: convert sysfs.txt to reST Jaskaran Singh
2019-11-07 19:04 ` Jonathan Corbet
2019-11-09 13:06 ` Jaskaran Singh
2019-11-12 17:04 ` Jonathan Corbet
2019-11-13 7:30 ` Jaskaran Singh [this message]
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=97b1695ebcbd2dd5ce8c117af0232ad6a1fee20f.camel@gmail.com \
--to=jaskaransingh7654321@gmail.com \
--cc=christian@brauner.io \
--cc=corbet@lwn.net \
--cc=hofrat@osadl.org \
--cc=jeffrey.t.kirsher@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
--cc=neilb@suse.com \
--cc=stefanha@redhat.com \
--cc=tobin@kernel.org \
--cc=willy@infradead.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).