* [PATCH] fs: direct-io: Fixed a Documentation build warn
@ 2019-09-24 12:19 Madhuparna Bhowmik
2019-09-24 12:23 ` Matthew Wilcox
0 siblings, 1 reply; 4+ messages in thread
From: Madhuparna Bhowmik @ 2019-09-24 12:19 UTC (permalink / raw)
To: linux-kernel-mentees; +Cc: linux-kernel, linux-fsdevel
warning: Excess function parameter 'offset' description in
'dio_complete'.
This patch removes offset from the list of arguments from the function
header as it not an argument to the function. Adds the description about
offset within the code.
Signed-off-by: Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com>
---
fs/direct-io.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/fs/direct-io.c b/fs/direct-io.c
index ae196784f487..a9cb770f0bc1 100644
--- a/fs/direct-io.c
+++ b/fs/direct-io.c
@@ -243,7 +243,6 @@ void dio_warn_stale_pagecache(struct file *filp)
/**
* dio_complete() - called when all DIO BIO I/O has been completed
- * @offset: the byte offset in the file of the completed operation
*
* This drops i_dio_count, lets interested parties know that a DIO operation
* has completed, and calculates the resulting return code for the operation.
@@ -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;
--
2.17.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] fs: direct-io: Fixed a Documentation build warn
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 ` [Linux-kernel-mentees] " Shuah Khan
0 siblings, 1 reply; 4+ messages in thread
From: Matthew Wilcox @ 2019-09-24 12:23 UTC (permalink / raw)
To: Madhuparna Bhowmik; +Cc: linux-kernel-mentees, linux-kernel, linux-fsdevel
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [Linux-kernel-mentees] [PATCH] fs: direct-io: Fixed a Documentation build warn
2019-09-24 12:23 ` Matthew Wilcox
@ 2019-09-24 13:16 ` Shuah Khan
0 siblings, 0 replies; 4+ messages in thread
From: Shuah Khan @ 2019-09-24 13:16 UTC (permalink / raw)
To: Matthew Wilcox, Madhuparna Bhowmik
Cc: linux-fsdevel, linux-kernel-mentees, linux-kernel,
skh >> Shuah Khan
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH] fs: direct-io: Fixed a Documentation build warn
@ 2019-09-25 20:06 Madhuparna Bhowmik
0 siblings, 0 replies; 4+ messages in thread
From: Madhuparna Bhowmik @ 2019-09-25 20:06 UTC (permalink / raw)
To: linux-kernel-mentees; +Cc: linux-fsdevel
This patch fixes the warning: Excess function parameter 'offset'
description in 'dio_complete'.
Removes offset from the list of arguments in the function
header as it not an argument to the function.
Signed-off-by: Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com>
---
fs/direct-io.c | 1 -
1 file changed, 1 deletion(-)
diff --git a/fs/direct-io.c b/fs/direct-io.c
index ae196784f487..636a61036ffe 100644
--- a/fs/direct-io.c
+++ b/fs/direct-io.c
@@ -243,7 +243,6 @@ void dio_warn_stale_pagecache(struct file *filp)
/**
* dio_complete() - called when all DIO BIO I/O has been completed
- * @offset: the byte offset in the file of the completed operation
*
* This drops i_dio_count, lets interested parties know that a DIO operation
* has completed, and calculates the resulting return code for the operation.
--
2.17.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
end of thread, other threads:[~2019-09-25 20:06 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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 ` [Linux-kernel-mentees] " Shuah Khan
2019-09-25 20:06 Madhuparna Bhowmik
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).