From patchwork Thu Jun 25 16:31:21 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11625695 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 2B92F60D for ; Thu, 25 Jun 2020 16:34:03 +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 011BC206C3 for ; Thu, 25 Jun 2020 16:34:03 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="B76XvG6a"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="eCsjtb0C" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 011BC206C3 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=pcuoJQIMPbBHMsoEtjNK+tJzT4xZ2C9fyiSEsSb7M2A=; b=B76XvG6aAhYXPNChrxhX9zVUa iL8GxpEWPdHKD2wO2mIZBXjwoE3t/zv4Q9OU0LrB4vgYDU90soMDELHrUale6ylR0eL2WmrU6qL3j NN78nv6egzOnDmKy0Gbil9QcPVJpuP68r6Cd2Pg78K8hB02GtSNqWpl/E+KcUCoyvNfb63U7wv5i3 Plbx7PWit4F9aftjVOwDcXmfb9SKhhg0d6EuTs+RGGrMSEJrM9+2naXCadnhJgDFhF2hIXTG/AAKU JFwpUWRWNZRy8g+RGJExG/HBp8pKOMF/Ao7dsgW5WxXZ24C1Dt6BLPYPyOCHlb4dIBPj5RVCb/NGq yn879h8Aw==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1joUnH-00043a-MM; Thu, 25 Jun 2020 16:32:07 +0000 Received: from mail-wm1-x344.google.com ([2a00:1450:4864:20::344]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1joUmo-0003tv-Vs for linux-arm-kernel@lists.infradead.org; Thu, 25 Jun 2020 16:31:40 +0000 Received: by mail-wm1-x344.google.com with SMTP id q15so6189055wmj.2 for ; Thu, 25 Jun 2020 09:31:38 -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=EoDDRWYqSRFNxuy0oLGiJ2BCcmCTg6+79vgN6npQkDY=; b=eCsjtb0CD0LDkL/xpQgVQpUKp46erAgw6x4yrXv2r8sD3j++WjCcmIyOt1/Ru6SBKS 31Wn7T59R8BrNIi+NbhvYd1Dwd7McIkOUfHsMrPDmjJ7Eevz7+PwJ2mZlbE1thlXu6td qpIf95KNd37Ub8rtfwRk8obKD8t7NdwtO3qLfJpkGf56W6hHceqWDZe+g+lR3tycgaNf ftPDOpr/JIFpSRm/X6hLfJOuvtaGSqyecEG6Wmnilnk7XeamBZuOZ30XIIiCyLLJ6FyS /lod4D62NPUbBm6aLWDd0162ZdkwbS2gLu+NVSsCgaDE7Gsv93oeh4HR1+6xDDHaJ0jt 8iUw== 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=EoDDRWYqSRFNxuy0oLGiJ2BCcmCTg6+79vgN6npQkDY=; b=QTS1R8hX6GcgJdxFARIcSa4fIQNE6mFB0LTBMqa/nWewITnA5jbZuZlwsEKCNvRwLe JjMwD/R1kkKziyMfGiprGA/AV4yUrae4jYefHGPGCs+VK6LE18dI2llAEJ+Oky9/VhsX OPjJ/93L9u8X5023CY1SuxJce9l8SJ7cfeLOA1D+gYeLvQtL7oj1aSDqbY1HMMmduXgA Jj/GC1v/2rMWYBw5PnG8FZoEKNrY/vZ04SdeIOIlPBNYk6IetLAS90gq1Ym0UfdR8Rw4 cvGUaC2QnjPnPMYrkPsIvp4bmVl509FHT/KwYpe5gMh4ddSg0uXcff2/Qw6gXM13cglb yUCQ== X-Gm-Message-State: AOAM530mIKHMh3V2qkRkr1icRWMndOcQXaaO73zV+n/dwa4fE0Z24lAd YeNGyUatOiczdg744lrLcZsdSg== X-Google-Smtp-Source: ABdhPJxs0E1ZwZRgy1IPBlo62VKJtW4RR3mcSMYVd6SruY6FQ67fUZ/rYYoLZFZyV6U9/jG7A6WazQ== X-Received: by 2002:a7b:cbcb:: with SMTP id n11mr4041219wmi.99.1593102698025; Thu, 25 Jun 2020 09:31:38 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id l8sm32090847wrq.15.2020.06.25.09.31.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Jun 2020 09:31:37 -0700 (PDT) From: Lee Jones To: lee.jones@linaro.org Subject: [PATCH 04/10] mfd: ab3100-otp: Add missing colon(s) for all documented kerneldoc arguments Date: Thu, 25 Jun 2020 17:31:21 +0100 Message-Id: <20200625163127.4000462-5-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200625163127.4000462-1-lee.jones@linaro.org> References: <20200625163127.4000462-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:344 listed in] [list.dnswl.org] -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -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 -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature 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: Linus Walleij , 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 Kerneldoc validation gets confused if syntax isn't "@.*: ". Adding the missing colons squashes the following W=1 warnings: drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'dev' not described in 'ab3100_otp' drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'locked' not described in 'ab3100_otp' drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'freq' not described in 'ab3100_otp' drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'paf' not described in 'ab3100_otp' drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'imeich' not described in 'ab3100_otp' drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'cid' not described in 'ab3100_otp' drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'tac' not described in 'ab3100_otp' drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'fac' not described in 'ab3100_otp' drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'svn' not described in 'ab3100_otp' drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'debugfs' not described in 'ab3100_otp' Cc: Linus Walleij Signed-off-by: Lee Jones Reviewed-by: Linus Walleij --- drivers/mfd/ab3100-otp.c | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/drivers/mfd/ab3100-otp.c b/drivers/mfd/ab3100-otp.c index c4751fb9bc224..c393102e3a394 100644 --- a/drivers/mfd/ab3100-otp.c +++ b/drivers/mfd/ab3100-otp.c @@ -29,22 +29,22 @@ /** * struct ab3100_otp - * @dev containing device - * @locked whether the OTP is locked, after locking, no more bits + * @dev: containing device + * @locked: whether the OTP is locked, after locking, no more bits * can be changed but before locking it is still possible * to change bits from 1->0. - * @freq clocking frequency for the OTP, this frequency is either + * @freq: clocking frequency for the OTP, this frequency is either * 32768Hz or 1MHz/30 - * @paf product activation flag, indicates whether this is a real + * @paf: product activation flag, indicates whether this is a real * product (paf true) or a lab board etc (paf false) - * @imeich if this is set it is possible to override the + * @imeich: if this is set it is possible to override the * IMEI number found in the tac, fac and svn fields with * (secured) software - * @cid customer ID - * @tac type allocation code of the IMEI - * @fac final assembly code of the IMEI - * @svn software version number of the IMEI - * @debugfs a debugfs file used when dumping to file + * @cid: customer ID + * @tac: type allocation code of the IMEI + * @fac: final assembly code of the IMEI + * @svn: software version number of the IMEI + * @debugfs: a debugfs file used when dumping to file */ struct ab3100_otp { struct device *dev;