From patchwork Thu Aug 24 22:11:09 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 110958 Delivered-To: patch@linaro.org Received: by 10.140.95.78 with SMTP id h72csp74567qge; Thu, 24 Aug 2017 15:11:28 -0700 (PDT) X-Received: by 10.84.229.10 with SMTP id b10mr8371932plk.353.1503612688764; Thu, 24 Aug 2017 15:11:28 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1503612688; cv=none; d=google.com; s=arc-20160816; b=qmph/7PHNjta+gN9iZiGa+Zpa838gIm311ZrqXQSov+8c6Ba/yGH3ZWVT81Add2USK iQa5aT4C9OtWJNRUTVHFPzmG3Ljggfna05kt8vlXHivZOZN/gupWJNHUwDyWVnuMQ4Vc +qQ+iAYGbzKkeLBmrT6jdbnVG7PVDyW6YZgYbFOqzz4bTqgq9sc+KsoEf6GNw+TZGsX0 K0AKXpx0L+9f4jzOj9Dl23UT+OGTTSOIAGDLDW5Hl+yQN5k+jtbJm+z8ys5nE5H916WP wxASPs+Gy+UOtL/Uyf5u4ri+uisTcV05A7Ts3k9pjf4QfqnQNhQVUS64aiv98tw6EqBE dd9Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :organization:message-id:subject:cc:to:from:date :arc-authentication-results; bh=1sdrD1C2WaTGSM58FON9ejmqYr8pAIZTz5hmuKvZsOc=; b=Jg0KYFUFtv6ovHn702SJoLT+m+5LxEqVz4/Fyh/QWAU0Gj8R0LSHBOt4xCTG1n9CS3 339f7QrYcDlSqOHIczzGNvO0zQXLfMQqVBr+SEHhVDFeJ6xRHVQJUk6qV7PlwqvsVPYy hjxwAIT3eCUXaQ2WyCgN6pFqYuwttmqyFzHRO4dcle0NJFysHX8Mzrc/UKl1bwU/qbs/ F2Sol92+PnrUXpFnVXETjHlzCqRaUnEiKAv0coV9VvpZaQUq17gCiE9r+Cj28fumq2a1 wN3B9IbPjlx/0Q+qScviGXcvRrOPKmgiQn36bq0riRjs+EzN/NNlJ8WUEUWcoDM/HUPP quMQ== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-scsi-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-scsi-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id n29si3466077pfi.624.2017.08.24.15.11.28; Thu, 24 Aug 2017 15:11:28 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-scsi-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-scsi-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-scsi-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753590AbdHXWLM (ORCPT + 1 other); Thu, 24 Aug 2017 18:11:12 -0400 Received: from ms.lwn.net ([45.79.88.28]:48078 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753456AbdHXWLK (ORCPT ); Thu, 24 Aug 2017 18:11:10 -0400 Received: from lwn.net (localhost [127.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 2D99C2D0; Thu, 24 Aug 2017 22:11:10 +0000 (UTC) Date: Thu, 24 Aug 2017 16:11:09 -0600 From: Jonathan Corbet To: "James E.J. Bottomley" , "Martin K. Petersen" Cc: linux-scsi@vger.kernel.org, linux-doc@vger.kernel.org Subject: [PATCH] scsi: Fix the kerneldoc for scsi_initialize_rq() Message-ID: <20170824161109.6e23432b@lwn.net> Organization: LWN.net MIME-Version: 1.0 Sender: linux-scsi-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-scsi@vger.kernel.org The kerneldoc comment for scsi_initialize_rq() neglected to document the "rq" parameter, leading to this docs build warning: ./drivers/scsi/scsi_lib.c:1116: warning: No description found for parameter 'rq' Document the parameter and make the build slightly quieter. Signed-off-by: Jonathan Corbet --- drivers/scsi/scsi_lib.c | 1 + 1 file changed, 1 insertion(+) -- 2.13.4 diff --git a/drivers/scsi/scsi_lib.c b/drivers/scsi/scsi_lib.c index f6097b89d5d3..a76515814ee7 100644 --- a/drivers/scsi/scsi_lib.c +++ b/drivers/scsi/scsi_lib.c @@ -1108,6 +1108,7 @@ EXPORT_SYMBOL(scsi_init_io); /** * scsi_initialize_rq - initialize struct scsi_cmnd.req + * @rq: Request used to locate the scsi_cmnd structure. * * Called from inside blk_get_request(). */