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