From patchwork Wed Jul 15 09:57:02 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vinod Koul X-Patchwork-Id: 11664693 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 7B75E6C1 for ; Wed, 15 Jul 2020 09:58:12 +0000 (UTC) Received: from alsa0.perex.cz (alsa0.perex.cz [77.48.224.243]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 1002D2064C for ; Wed, 15 Jul 2020 09:58:12 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=alsa-project.org header.i=@alsa-project.org header.b="D1avQRvV"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="KGivZ6c5" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 1002D2064C Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=alsa-devel-bounces@alsa-project.org Received: from alsa1.perex.cz (alsa1.perex.cz [207.180.221.201]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by alsa0.perex.cz (Postfix) with ESMTPS id 681BD15F2; Wed, 15 Jul 2020 11:57:24 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.11.0 alsa0.perex.cz 681BD15F2 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=alsa-project.org; s=default; t=1594807090; bh=HXp/0XEEVTqH0xfMOc8VdBJLSdPJrdSwmX52IFqiuEE=; h=From:To:Subject:Date:Cc:List-Id:List-Unsubscribe:List-Archive: List-Post:List-Help:List-Subscribe:From; b=D1avQRvVAYgE4vfO1QtK0gKJHI4Cy0fxl8hYN8HUd5TetF7N9vH0uPl0G8sM0Qb0N L6p8S+gcFXGrumKd3jdUumViHIw5bWrD6t0EpF+RTt5m+aHkca6OwTzmcfksiXxW/a P/N4b5jfZffDdj8nSaC2LKLBnfZYpovKKeXwI0Ak= Received: from alsa1.perex.cz (localhost.localdomain [127.0.0.1]) by alsa1.perex.cz (Postfix) with ESMTP id E3205F8014E; Wed, 15 Jul 2020 11:57:23 +0200 (CEST) X-Original-To: alsa-devel@alsa-project.org Delivered-To: alsa-devel@alsa-project.org Received: by alsa1.perex.cz (Postfix, from userid 50401) id 04D86F80113; Wed, 15 Jul 2020 11:57:21 +0200 (CEST) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on alsa1.perex.cz X-Spam-Level: X-Spam-Status: No, score=-0.1 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,SPF_HELO_NONE,SPF_PASS autolearn=disabled version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by alsa1.perex.cz (Postfix) with ESMTPS id CAEE8F80113 for ; Wed, 15 Jul 2020 11:57:14 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.11.0 alsa1.perex.cz CAEE8F80113 Authentication-Results: alsa1.perex.cz; dkim=pass (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="KGivZ6c5" Received: from localhost.localdomain (unknown [122.171.202.192]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 9D0C62064C; Wed, 15 Jul 2020 09:57:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1594807032; bh=HXp/0XEEVTqH0xfMOc8VdBJLSdPJrdSwmX52IFqiuEE=; h=From:To:Cc:Subject:Date:From; b=KGivZ6c5RWhjMCle4+iH/Z4+9Kofy0yS/Z9YPq2WKZSMUtproW/DPnsbphjyvRkEq xPKHQVEgdiP0i2QffgDrs7xjWrzhrGCiCS1cj1KaU+ePuOBlEpG5wbYNAR4OO9Z6bl lBIOmytsLfda2/HXUWQNV6UwpRkT/tOq8HGkheVQ= From: Vinod Koul To: alsa-devel@alsa-project.org Subject: [PATCH] soundwire: fix the kernel-doc comment Date: Wed, 15 Jul 2020 15:27:02 +0530 Message-Id: <20200715095702.1519554-1-vkoul@kernel.org> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Cc: Vinod Koul , Sanyog Kale , Bard Liao , Pierre-Louis Bossart X-BeenThere: alsa-devel@alsa-project.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: "Alsa-devel mailing list for ALSA developers - http://www.alsa-project.org" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: alsa-devel-bounces@alsa-project.org Sender: "Alsa-devel" sdw_startup_stream() and sdw_shutdown_stream() argument has been updated but not the comments, so update these as well to fix warning with W=1 drivers/soundwire/stream.c:1859: warning: Function parameter or member 'sdw_substream' not described in 'sdw_startup_stream' drivers/soundwire/stream.c:1859: warning: Excess function parameter 'stream' description in 'sdw_startup_stream' drivers/soundwire/stream.c:1903: warning: Function parameter or member 'sdw_substream' not described in 'sdw_shutdown_stream' drivers/soundwire/stream.c:1903: warning: Excess function parameter 'stream' description in 'sdw_shutdown_stream' Signed-off-by: Vinod Koul Reviewed-by: Pierre-Louis Bossart --- drivers/soundwire/stream.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/drivers/soundwire/stream.c b/drivers/soundwire/stream.c index 6bc2ff29c202..37290a799023 100644 --- a/drivers/soundwire/stream.c +++ b/drivers/soundwire/stream.c @@ -1851,7 +1851,7 @@ static int set_stream(struct snd_pcm_substream *substream, /** * sdw_startup_stream() - Startup SoundWire stream * - * @stream: Soundwire stream + * @sdw_substream: Soundwire stream * * Documentation/driver-api/soundwire/stream.rst explains this API in detail */ @@ -1895,7 +1895,7 @@ EXPORT_SYMBOL(sdw_startup_stream); /** * sdw_shutdown_stream() - Shutdown SoundWire stream * - * @stream: Soundwire stream + * @sdw_substream: Soundwire stream * * Documentation/driver-api/soundwire/stream.rst explains this API in detail */