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=-9.1 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_PASS, USER_AGENT_GIT autolearn=ham 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 AA743C43381 for ; Wed, 27 Mar 2019 05:18:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 776272082F for ; Wed, 27 Mar 2019 05:18:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1553663919; bh=U8N7m1V+G9+NLprEwj+MJyZyF7xeXi+EuK2cQZb7Css=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=xY9TRvENVpD2a4suEUgBt4RX29Oig+bPVEPl9A2xz1EE6mKv8kR1QKgarbgRDAzrH IMqa2vxkJ0XquAW5mPDlH7ieO8MVxLA2KDgwJYoN1rMemVP9BKXXbLaazdJJN1Unz+ QXW7U/UjJiblE/VPwGpMq+rQpshm1Ma2Uz6k1CDg= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1732637AbfC0FSi (ORCPT ); Wed, 27 Mar 2019 01:18:38 -0400 Received: from out3-smtp.messagingengine.com ([66.111.4.27]:33101 "EHLO out3-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725805AbfC0FSh (ORCPT ); Wed, 27 Mar 2019 01:18:37 -0400 Received: from compute3.internal (compute3.nyi.internal [10.202.2.43]) by mailout.nyi.internal (Postfix) with ESMTP id 13BBA2214E; Wed, 27 Mar 2019 01:18:36 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute3.internal (MEProxy); Wed, 27 Mar 2019 01:18:36 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:date:from :in-reply-to:message-id:mime-version:references:subject:to :x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm2; bh=Gi/oZKDoLMBdJHiaZfzQGRUahj2/6JIrGqILLjPpIYU=; b=fxYDu3N6 /MV59jmVeBdRqaH/NZihQPuR/8UVCD0YlUX2UK9jDji/UF+RoZi9pYyP8OLPZKr8 aMxk1CWuf/lq48LSfYeDQY0qkOc0TnfnQkThjz1KtI8kFBLbWMQDHg4/W7JRUSyg tvzOpKFq4fKL3467YG3zCSNzYw2YetGv+ayO21VYYXhQG3kCRujCB2YE/adfRLi4 jTIOhRFCNHMNvH8AN1rB/FXaYOYbYBTRPmIbsBJHfwKaSRh6L8sac9A1Gp65I4Ty DK1a0LLILUPJq7YVu8uUovji/7ah7x+KMYgnnbUVjyosmIoF7a2qJkjhIfDUCkrP yeMEveLzlnzjpg== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedutddrkedugdektdcutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvffufffkofgjfhgggfestdekredtredttdenucfhrhhomhepfdfvohgsihhn ucevrdcujfgrrhguihhnghdfuceothhosghinheskhgvrhhnvghlrdhorhhgqeenucfkph epuddvgedrudeiledrudefledrudelvdenucfrrghrrghmpehmrghilhhfrhhomhepthho sghinheskhgvrhhnvghlrdhorhhgnecuvehluhhsthgvrhfuihiivgepvd X-ME-Proxy: Received: from eros.localdomain (124-169-139-192.dyn.iinet.net.au [124.169.139.192]) by mail.messagingengine.com (Postfix) with ESMTPA id 8AADEE415C; Wed, 27 Mar 2019 01:18:32 -0400 (EDT) From: "Tobin C. Harding" To: Al Viro Cc: "Tobin C. Harding" , Jonathan Corbet , Mauro Carvalho Chehab , Neil Brown , Randy Dunlap , linux-doc@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 03/24] fs: Update function docstring for dio_complete() Date: Wed, 27 Mar 2019 16:16:56 +1100 Message-Id: <20190327051717.23225-4-tobin@kernel.org> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190327051717.23225-1-tobin@kernel.org> References: <20190327051717.23225-1-tobin@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Sphinx throws a warning when parsing fs/direct_io.c, the warning illuminates the fact that the docstring for function dio_complete() has become stale. Update the function docstring for dio_complete() documenting all current function parameters. Signed-off-by: Tobin C. Harding --- fs/direct-io.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/fs/direct-io.c b/fs/direct-io.c index dbc1a1f080ce..ce5fd5f8603c 100644 --- a/fs/direct-io.c +++ b/fs/direct-io.c @@ -242,7 +242,9 @@ 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 + * @dio: The dio we are working on. + * @ret: Error code passed through from do_blockdev_direct_IO(). + * @flags: DIO complete flags. * * 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.21.0