From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.4 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_1 autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id B943DC432C1 for ; Tue, 24 Sep 2019 13:16:30 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 85E8C214AF for ; Tue, 24 Sep 2019 13:16:30 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1569330990; bh=dBf16uSBC3fnl+ZQos6hHoXefs1lQfAvZkI2t8GiKec=; h=Subject:To:Cc:References:From:Date:In-Reply-To:List-ID:From; b=E900OyBgKTlhuOb1QCcioURG/B6hAV0y6zXZYwVCDYY9upZjWbF4Hg5aAN8A7TT89 NyB/q7j+yt9flm+eOldAz/LKFlbvcYzT75kqroPMo9YvEDU5P/ZcevkoPE6Lo+rZKq Yji5RxeWYFtiLbVmojq9UbBaTUPTe68uykt4ToXY= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2441111AbfIXNQ0 (ORCPT ); Tue, 24 Sep 2019 09:16:26 -0400 Received: from mail-io1-f66.google.com ([209.85.166.66]:36362 "EHLO mail-io1-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2395385AbfIXNQ0 (ORCPT ); Tue, 24 Sep 2019 09:16:26 -0400 Received: by mail-io1-f66.google.com with SMTP id b136so4316954iof.3 for ; Tue, 24 Sep 2019 06:16:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linuxfoundation.org; s=google; h=subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=zmFb2EMPloIisV5Kbr6QTdeXVJWyxzGPjlF8jdYtZhY=; b=R97y2O7h9JpTxo7iTteQf4D7XlmtHn3jhm1kp3BIoSz5set7pFabIamGi+la/YSSwA FKGjyThEpL1gPa7KpFIFBs3epahZfzxtyBidNH8SkuXbdY3QtCuTYSJcrgmpZAAcjCA0 w+ios0UGkygezyBYMaYxt8h+ryzqSF2ubgvrQ= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=zmFb2EMPloIisV5Kbr6QTdeXVJWyxzGPjlF8jdYtZhY=; b=PJ65k7toIM+O59ZTcsjOyi+3zaLyBCpQKAibc36vy6chutrd7AziXCBrQEayUSdFok ajsh/y/4zapiyqfoHMHdxMlCzMdfRTmY8O3OxyZUpzmiXc0oWwpaHrdMbbp2ynzlONCG TbAteKScClP7DDhudGvrVJW5Xq3XkB91VR+arV4a+VoTLzZJjDiMPr/RFxZ1oo64QbJf BHxqbaAY/mj4lG89nhXdpljjqFyxPrM6ZyMNeHQnRc/unm9EciinuUVcyNBHwaxSCdJ+ ttINPrVUFoy/ThRpnr/y+S0eIrSf6QXy0Wlg5BNbkUE8cYZiuR5ggJ9fCQII5Qlv+HsG Ex6A== X-Gm-Message-State: APjAAAUnZQMg0StvIGIpyV8NhSMzD3Kv934HJNjBEn1xtPvKZxOFSNHv xlmTIQ1k4LXL6U+ZDWo3tWCRXQ== X-Google-Smtp-Source: APXvYqy0/c6Bw5NCycjajmI4b6HkHz357M5g1ZkwNKeK3jsgURWsZ+G/d89Bw77UGLHILQXiWxk1Ww== X-Received: by 2002:a6b:7d4c:: with SMTP id d12mr72693ioq.165.1569330985186; Tue, 24 Sep 2019 06:16:25 -0700 (PDT) Received: from [192.168.1.112] (c-24-9-64-241.hsd1.co.comcast.net. [24.9.64.241]) by smtp.gmail.com with ESMTPSA id m67sm3374880iof.21.2019.09.24.06.16.23 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 24 Sep 2019 06:16:24 -0700 (PDT) Subject: Re: [Linux-kernel-mentees] [PATCH] fs: direct-io: Fixed a Documentation build warn To: Matthew Wilcox , Madhuparna Bhowmik Cc: linux-fsdevel@vger.kernel.org, linux-kernel-mentees@lists.linuxfoundation.org, linux-kernel@vger.kernel.org, "skh >> Shuah Khan" References: <20190924121920.GA4593@madhuparna-HP-Notebook> <20190924122310.GF1855@bombadil.infradead.org> From: Shuah Khan Message-ID: <684ef896-5062-0997-99fe-8395e9f05d9b@linuxfoundation.org> Date: Tue, 24 Sep 2019 07:16:23 -0600 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.8.0 MIME-Version: 1.0 In-Reply-To: <20190924122310.GF1855@bombadil.infradead.org> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Sender: linux-fsdevel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.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