linux-fsdevel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Shuah Khan <skhan@linuxfoundation.org>
To: Matthew Wilcox <willy@infradead.org>,
	Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com>
Cc: linux-fsdevel@vger.kernel.org,
	linux-kernel-mentees@lists.linuxfoundation.org,
	linux-kernel@vger.kernel.org,
	"skh >> Shuah Khan" <skhan@linuxfoundation.org>
Subject: Re: [Linux-kernel-mentees] [PATCH] fs: direct-io: Fixed a Documentation build warn
Date: Tue, 24 Sep 2019 07:16:23 -0600	[thread overview]
Message-ID: <684ef896-5062-0997-99fe-8395e9f05d9b@linuxfoundation.org> (raw)
In-Reply-To: <20190924122310.GF1855@bombadil.infradead.org>

On 9/24/19 6:23 AM, Matthew Wilcox wrote:
> On Tue, Sep 24, 2019 at 05:49:25PM +0530, Madhuparna Bhowmik wrote:
>> Adds the description about
>> offset within the code.
> 
> Why?
> 
>> @@ -255,6 +254,7 @@ void dio_warn_stale_pagecache(struct file *filp)
>>    */
>>   static ssize_t dio_complete(struct dio *dio, ssize_t ret, unsigned int flags)
>>   {
>> +	/* offset: the byte offset in the file of the completed operation */
>>   	loff_t offset = dio->iocb->ki_pos;
>>   	ssize_t transferred = 0;
>>   	int err;
> 
> This is not normal practice within the Linux kernel.  I suggest reading
> section 8 of Documentation/process/coding-style.rst
> 

You don't combine documentation and code patches. I don't think you need
to add this comment in here.

thanks,
-- Shuah


      reply	other threads:[~2019-09-24 13:16 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-24 12:19 [PATCH] fs: direct-io: Fixed a Documentation build warn Madhuparna Bhowmik
2019-09-24 12:23 ` Matthew Wilcox
2019-09-24 13:16   ` Shuah Khan [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=684ef896-5062-0997-99fe-8395e9f05d9b@linuxfoundation.org \
    --to=skhan@linuxfoundation.org \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=madhuparnabhowmik04@gmail.com \
    --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).