From patchwork Mon Jun 29 14:04:23 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11630987 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 0EA4992A for ; Mon, 29 Jun 2020 14:07:14 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (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 DB31823D98 for ; Mon, 29 Jun 2020 14:07:13 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="saj3x6NS"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="bWI/Qpg8" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org DB31823D98 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To:Message-Id:Date: Subject:To:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=/YjrgdbXfLLt7LKabCZBxYrAzA/wn2GdrehhOzPteXw=; b=saj3x6NSfsxv1S3LMAt3COzha WG45fctr75u86EMRNWgp++HzMK/zYyjHSSlb3j6Ict2PK+2UGnrWOYOuYFatQLaunJZSO/r2/8d+Y 2ozCD1dVmn0Al4/CFDwUbNiSKDqmLl7tTNiRYtr31Wvy2oZPKishqgK/gKpucT4ftpri2/XKig9K2 f5zseUiLgn4iOGmIho2WcwktyXL5Em9l2u1wLYdFkySvsgV+ZlrQf1BpsHDBLSD0YvOxqmrFeUmHb Q4XI/t/awOIP5zPyjxDYqJz4Zw/bUbDrzH4bN3nfXLrAkeKgKV+RsxrPTIHW1qyZLJlZ+yJ4Mfg94 6ENDF9+oA==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jpuP3-0004Dz-3N; Mon, 29 Jun 2020 14:04:57 +0000 Received: from mail-wr1-x443.google.com ([2a00:1450:4864:20::443]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jpuOu-0004BN-1P for linux-arm-kernel@lists.infradead.org; Mon, 29 Jun 2020 14:04:49 +0000 Received: by mail-wr1-x443.google.com with SMTP id h5so16665041wrc.7 for ; Mon, 29 Jun 2020 07:04:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=awbvdf/o8WJSBn2jZAYd3v4hbJ6rKznLBA9Uh+6bpSY=; b=bWI/Qpg8KHMiyukEPTm6FGM05U/4gMMkQHOHo8Nz82wB1fM52NfEp9sQEYJxW2Admn 36jXiYmOkyXpV+MMfSlpZT8Z9s9TZYZBTkr+WU+AkV6levgYIww9eFqKcfy+b7aov0Ar aSA6O4aQYnrIzAVcN2+hH+w3Fx7vH5ROlRP5Q22Uxuts5CNaQr/iw9JPKy3+nzLruCX5 rCb9EPkFb0B6QKG1l2+sEq1zz5+b6EgH7+TAMVkNi3o6cKbwRjBq67YFLhSGVkXgCcOv 8znzvVP02lrg2wbkpchzZYSHLbUR3k6W/ri5p3Tqp9XejF7alIJ68AbMxV5b4psyB5Oe c7RA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=awbvdf/o8WJSBn2jZAYd3v4hbJ6rKznLBA9Uh+6bpSY=; b=RvmArk9GWbVuo4ALOtgiTcQgT3Bel1ib+EUtG2KyOXOougvCv6LvuKi6DslDK3Bcjw AuLousw4I0jUNrouTEB67sj9z55YDV+1JkdwaVibxfhRD90XHejU/mEddQ1PEUX08OkU ze/SpII9e7CVYY8HOgKYru88IFzokWZ1PT/6xHvwa4kb27X2hD/7K/+5g7p/9A075EFb drDwyomPd/W9h8BB6hSZEQfA797Zs2nRz10VTN9j2L6q8OWBpw7esuD6xynRQDTu3lUz Uhmsb+vIaRgn6llTCLiJyk1lZfxGTRHXORAQhZ5q8Asp1F2UtM5l731KYJT3ajAZHuCp 89XQ== X-Gm-Message-State: AOAM530myOibC4QcBlaHTxCX6e2/tz/cFzyhLW3T4aA48mIRRGQ1zY3P /M0nbabACIEF3SN2ZSvADKsrqA== X-Google-Smtp-Source: ABdhPJwlYoQKfNVdDrit+2utE+6X7YuQwjowoDK8uijEIVf5IcJ4q9wfncz9T8GKzXHC/FOuq3rmSw== X-Received: by 2002:a5d:4603:: with SMTP id t3mr18518133wrq.38.1593439487048; Mon, 29 Jun 2020 07:04:47 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id p14sm15394928wrj.14.2020.06.29.07.04.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 29 Jun 2020 07:04:46 -0700 (PDT) From: Lee Jones To: arnd@arndb.de, gregkh@linuxfoundation.org Subject: [PATCH 01/20] misc: pti: Repair kerneldoc formatting issues Date: Mon, 29 Jun 2020 15:04:23 +0100 Message-Id: <20200629140442.1043957-2-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200629140442.1043957-1-lee.jones@linaro.org> References: <20200629140442.1043957-1-lee.jones@linaro.org> MIME-Version: 1.0 X-Spam-Note: CRM114 invocation failed X-Spam-Score: -0.2 (/) X-Spam-Report: SpamAssassin version 3.4.4 on merlin.infradead.org summary: Content analysis details: (-0.2 points) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [2a00:1450:4864:20:0:0:0:443 listed in] [list.dnswl.org] 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.0 SPF_PASS SPF: sender matches SPF record -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: J Freyensee , Lee Jones , linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org W=1 kernel builds report a lack of descriptions for various function arguments. In reality they are documented, but the formatting was not as expected '@.*:'. Instead, '-'s were used as separators. This change fixes the following warnings: drivers/misc/pti.c:748: warning: Function parameter or member 'port' not described in 'pti_port_activate' drivers/misc/pti.c:748: warning: Function parameter or member 'tty' not described in 'pti_port_activate' drivers/misc/pti.c:765: warning: Function parameter or member 'port' not described in 'pti_port_shutdown' drivers/misc/pti.c:793: warning: Function parameter or member 'pdev' not described in 'pti_pci_probe' drivers/misc/pti.c:793: warning: Function parameter or member 'ent' not described in 'pti_pci_probe' Cc: J Freyensee Signed-off-by: Lee Jones --- drivers/misc/pti.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/drivers/misc/pti.c b/drivers/misc/pti.c index 07e9da7918ebd..e19988766aa69 100644 --- a/drivers/misc/pti.c +++ b/drivers/misc/pti.c @@ -733,8 +733,8 @@ static struct console pti_console = { * pti_port_activate()- Used to start/initialize any items upon * first opening of tty_port(). * - * @port- The tty port number of the PTI device. - * @tty- The tty struct associated with this device. + * @port: The tty port number of the PTI device. + * @tty: The tty struct associated with this device. * * Returns: * always returns 0 @@ -754,7 +754,7 @@ static int pti_port_activate(struct tty_port *port, struct tty_struct *tty) * pti_port_shutdown()- Used to stop/shutdown any items upon the * last tty port close. * - * @port- The tty port number of the PTI device. + * @port: The tty port number of the PTI device. * * Notes: The primary purpose of the PTI tty port 0 is to hook * the syslog daemon to it; thus this port will be open for a @@ -780,8 +780,8 @@ static const struct tty_port_operations tty_port_ops = { * pti_pci_probe()- Used to detect pti on the pci bus and set * things up in the driver. * - * @pdev- pci_dev struct values for pti. - * @ent- pci_device_id struct for pti driver. + * @pdev: pci_dev struct values for pti. + * @ent: pci_device_id struct for pti driver. * * Returns: * 0 for success