From patchwork Thu Mar 30 17:45:05 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marco Pagani X-Patchwork-Id: 77352 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp34908vqo; Thu, 30 Mar 2023 10:58:30 -0700 (PDT) X-Google-Smtp-Source: AKy350aOIMlvwhuj/c5AVmN6qzXPLJuZWQ9L5RyxxgkpYYlxWx3/LLaai1hsPEoj7NOGyExsYMMv X-Received: by 2002:a17:907:2059:b0:8af:2107:6ce5 with SMTP id pg25-20020a170907205900b008af21076ce5mr21186446ejb.35.1680199109872; Thu, 30 Mar 2023 10:58:29 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1680199109; cv=none; d=google.com; s=arc-20160816; b=kmWHTPAKWm5vvXEI7wPEfujMeqmTDX6CwypHHq++XQ3DcC0GpNvl8tGQkC9eKgxo/2 2rOfdjARUE6QoC4cdO72WTE34WQTUL3IQHBgv6CWtuDW8zj+MLQjylsAXxCyJ+PZT5vG J/dhSd78G22NBEpnReA97vSwLkMEuJevhM7HzeH3/b3/VAaog32qxn6FnZ3MrA6WrhQt QmvTsXfNDo3ibYZY/I5NCSmEH/3+C9TdfoIBWeX0G+R87ySh47Q7owXoUxRT4yQXidcd cGeD/5pOKxxxwOn4txX5I20Wi6nL1NK+IaqiaTVais6/sI/+ZoxP5ho5eJmD4t8ZlBRI 46gg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=zFHJsI5sKs0NfMxgYnvDFDcHAOkfJF585rJ6FieeSVw=; b=m23aAB1wF4SApFoVGCgeJs667VfKBkBXXhFEYs8wId/Xz5Q9JIY6mVFF8q/CeC0e0D URatygM6bav8udA/wkUTDPii9UnFIwy7V3VgfnZokdvHZUMA+PpxNT8QupwLoGI/aWzK Zlw79q9SJ2fw9ai2mIlqm2E4JAXSLFsmdrXgOHXDmB5xWsmYL1jM1jUBa/NxFhf5MWsZ gQRZF4ikm4FZwBxDxTQZBviv8RkxSbDhby6sdhE00DPS72OmhydnaxvfbgFtPKmHusC5 gN8QDIsjNOyNtWfoHPZhrAf8dtsJfulavbJMT59KFlVshHNVL9PXjQ+zod7IAO9ju61H SPZw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=IuFAxwKg; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=redhat.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id q17-20020a170906145100b0094779d354efsi100297ejc.941.2023.03.30.10.58.05; Thu, 30 Mar 2023 10:58:29 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=IuFAxwKg; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=redhat.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232591AbjC3RqD (ORCPT + 99 others); Thu, 30 Mar 2023 13:46:03 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50586 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231984AbjC3RqB (ORCPT ); Thu, 30 Mar 2023 13:46:01 -0400 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 026DCEC46 for ; Thu, 30 Mar 2023 10:45:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1680198314; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=zFHJsI5sKs0NfMxgYnvDFDcHAOkfJF585rJ6FieeSVw=; b=IuFAxwKgPzwPRAhd/AAMzUoKRmdzWaC8x7uFYlFiYOK2AKZFMhmTE6iK/SHj9BNoScefgu dF1ebt0O5my5jpPWap/gdhfz7TfHVoXWciTC9p+BqErpjSlnDbJjhXJJqFLPIQHg3jos2V KAVaxlFzKDrNrlRntYUAV0W4TD+r8tw= Received: from mail-qk1-f199.google.com (mail-qk1-f199.google.com [209.85.222.199]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-572-N_Kl8hagPbq22SZ6rYGGLg-1; Thu, 30 Mar 2023 13:45:12 -0400 X-MC-Unique: N_Kl8hagPbq22SZ6rYGGLg-1 Received: by mail-qk1-f199.google.com with SMTP id s12-20020a37a90c000000b007468eaf866aso9278139qke.17 for ; Thu, 30 Mar 2023 10:45:12 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1680198312; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=zFHJsI5sKs0NfMxgYnvDFDcHAOkfJF585rJ6FieeSVw=; b=KCjmOkjPrTntK6OwCEv1yVnFHlmDbAdQNAUDvSbWp1UClWmvvuHtqWQDgazMjA+hY/ vcdwisIcWY3umkAjF9vZk4R79cKyZgVVQGvm6cqsqdfBF9/Ddy1/uds8hi+FD76AHJTZ gkfuk8yX4iORmmwXf3gzXwctYY6ZgZpDaCcP3ZBvWlFv1wjdBuq+NBwH4PRJSrOmuOMd NDPLqUGD2QgQsdhZ5N5XsubUqtsKj0qQA0x15w2YJ4JDhajTMvbMfg0vKxdwT9oV81w9 H3pFKlvgi6+UTi5YPyVrYeOW/yXLVG4Jgj5vLaqt9OvmI6XfzZ+SpymVnZekpxoFE2A1 3smQ== X-Gm-Message-State: AAQBX9ftVllmx0OlHB07PbA86VqxSxDhVSthNZzXmrnf4auQ4QncoEp7 pq2mui2OK9XdKMtpYWWujMUzHl6W5Rpp0MHyUF9Y8P7R4L2hZfHqBUufkIbUUh+IHX0EPmbcuhB la/QXe3QQCFl+yGhgURyZJt4= X-Received: by 2002:a05:6214:1250:b0:5b3:4b99:7af8 with SMTP id r16-20020a056214125000b005b34b997af8mr44775138qvv.21.1680198312111; Thu, 30 Mar 2023 10:45:12 -0700 (PDT) X-Received: by 2002:a05:6214:1250:b0:5b3:4b99:7af8 with SMTP id r16-20020a056214125000b005b34b997af8mr44775066qvv.21.1680198311657; Thu, 30 Mar 2023 10:45:11 -0700 (PDT) Received: from klayman.redhat.com (net-2-34-29-20.cust.vodafonedsl.it. [2.34.29.20]) by smtp.gmail.com with ESMTPSA id w22-20020a05620a0e9600b0074230493ccfsm19478qkm.73.2023.03.30.10.45.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 30 Mar 2023 10:45:11 -0700 (PDT) From: Marco Pagani To: Moritz Fischer , Wu Hao , Xu Yilun , Tom Rix Cc: Marco Pagani , linux-fpga@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH] fpga: bridge: fix kernel-doc Date: Thu, 30 Mar 2023 19:45:05 +0200 Message-Id: <20230330174505.158920-1-marpagan@redhat.com> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 X-Spam-Status: No, score=-0.2 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_NONE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1761816461921868445?= X-GMAIL-MSGID: =?utf-8?q?1761816461921868445?= Fix the following warnings issued by the kernel-doc script: drivers/fpga/fpga-bridge.c:99: warning: No description found for return value of 'of_fpga_bridge_get' drivers/fpga/fpga-bridge.c:163: warning: No description found for return value of 'fpga_bridges_enable' drivers/fpga/fpga-bridge.c:187: warning: No description found for return value of 'fpga_bridges_disable' drivers/fpga/fpga-bridge.c:238: warning: No description found for return value of 'of_fpga_bridge_get_to_list' drivers/fpga/fpga-bridge.c:268: warning: No description found for return value of 'fpga_bridge_get_to_list' The patch is based on top of 38dbcd697770 ("fpga: bridge: fix kernel-doc parameter description"). Signed-off-by: Marco Pagani --- drivers/fpga/fpga-bridge.c | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c index ff4470067ed5..adb4a79a1b11 100644 --- a/drivers/fpga/fpga-bridge.c +++ b/drivers/fpga/fpga-bridge.c @@ -87,12 +87,13 @@ static struct fpga_bridge *__fpga_bridge_get(struct device *dev, /** * of_fpga_bridge_get - get an exclusive reference to an fpga bridge * - * @np: node pointer of an FPGA bridge - * @info: fpga image specific information + * @np: node pointer of an FPGA bridge. + * @info: fpga image specific information. * - * Return fpga_bridge struct if successful. - * Return -EBUSY if someone already has a reference to the bridge. - * Return -ENODEV if @np is not an FPGA Bridge. + * Return: + * * fpga_bridge struct pointer if successful. + * * -EBUSY if someone already has a reference to the bridge. + * * -ENODEV if @np is not an FPGA Bridge. */ struct fpga_bridge *of_fpga_bridge_get(struct device_node *np, struct fpga_image_info *info) @@ -155,9 +156,9 @@ EXPORT_SYMBOL_GPL(fpga_bridge_put); * fpga_bridges_enable - enable bridges in a list * @bridge_list: list of FPGA bridges * - * Enable each bridge in the list. If list is empty, do nothing. + * Enable each bridge in the list. If list is empty, do nothing. * - * Return 0 for success or empty bridge list; return error code otherwise. + * Return: 0 for success or empty bridge list; error code otherwise. */ int fpga_bridges_enable(struct list_head *bridge_list) { @@ -179,9 +180,9 @@ EXPORT_SYMBOL_GPL(fpga_bridges_enable); * * @bridge_list: list of FPGA bridges * - * Disable each bridge in the list. If list is empty, do nothing. + * Disable each bridge in the list. If list is empty, do nothing. * - * Return 0 for success or empty bridge list; return error code otherwise. + * Return: 0 for success or empty bridge list; error code otherwise. */ int fpga_bridges_disable(struct list_head *bridge_list) { @@ -230,7 +231,7 @@ EXPORT_SYMBOL_GPL(fpga_bridges_put); * * Get an exclusive reference to the bridge and it to the list. * - * Return 0 for success, error code from of_fpga_bridge_get() otherwise. + * Return: 0 for success, error code from of_fpga_bridge_get() otherwise. */ int of_fpga_bridge_get_to_list(struct device_node *np, struct fpga_image_info *info, @@ -260,7 +261,7 @@ EXPORT_SYMBOL_GPL(of_fpga_bridge_get_to_list); * * Get an exclusive reference to the bridge and it to the list. * - * Return 0 for success, error code from fpga_bridge_get() otherwise. + * Return: 0 for success, error code from fpga_bridge_get() otherwise. */ int fpga_bridge_get_to_list(struct device *dev, struct fpga_image_info *info,