Re: [Linux-kernel-mentees] [PATCH] fs: direct-io: Fixed a Documentation build warn

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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




[Index of Archives]     [Linux Ext4 Filesystem]     [Union Filesystem]     [Filesystem Testing]     [Ceph Users]     [Ecryptfs]     [AutoFS]     [Kernel Newbies]     [Share Photos]     [Security]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux Cachefs]     [Reiser Filesystem]     [Linux RAID]     [Samba]     [Device Mapper]     [CEPH Development]

  Powered by Linux