From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.2 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id D7B79C3A59F for ; Thu, 29 Aug 2019 21:33:25 +0000 (UTC) Received: from lists.ozlabs.org (lists.ozlabs.org [203.11.71.2]) (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 5B7942166E for ; Thu, 29 Aug 2019 21:33:25 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 5B7942166E Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linux.intel.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=linuxppc-dev-bounces+linuxppc-dev=archiver.kernel.org@lists.ozlabs.org Received: from bilbo.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 46KG7R1JN9zDsMN for ; Fri, 30 Aug 2019 07:33:23 +1000 (AEST) Authentication-Results: lists.ozlabs.org; spf=none (mailfrom) smtp.mailfrom=linux.intel.com (client-ip=134.134.136.20; helo=mga02.intel.com; envelope-from=sathyanarayanan.kuppuswamy@linux.intel.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=linux.intel.com Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 46HwNL4fFTzDq77 for ; Wed, 28 Aug 2019 03:09:53 +1000 (AEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 27 Aug 2019 10:09:51 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,438,1559545200"; d="scan'208";a="171263299" Received: from linux.intel.com ([10.54.29.200]) by orsmga007.jf.intel.com with ESMTP; 27 Aug 2019 10:09:50 -0700 Received: from [10.54.74.33] (skuppusw-desk.jf.intel.com [10.54.74.33]) by linux.intel.com (Postfix) with ESMTP id D0DE6580375; Tue, 27 Aug 2019 10:09:50 -0700 (PDT) Subject: Re: [PATCH v1 2/2] PCI/AER: Update parameter descriptions to satisfy kernel-doc validator To: Andy Shevchenko , Russell Currey , Sam Bobroff , Oliver O'Halloran , linuxppc-dev@lists.ozlabs.org, Bjorn Helgaas , linux-pci@vger.kernel.org References: <20190827151823.75312-1-andriy.shevchenko@linux.intel.com> <20190827151823.75312-2-andriy.shevchenko@linux.intel.com> From: Kuppuswamy Sathyanarayanan Organization: Intel Message-ID: <71eb8108-61a7-2815-4082-75c21f8bbf03@linux.intel.com> Date: Tue, 27 Aug 2019 10:06:54 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.8.0 MIME-Version: 1.0 In-Reply-To: <20190827151823.75312-2-andriy.shevchenko@linux.intel.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-Language: en-US X-Mailman-Approved-At: Fri, 30 Aug 2019 07:29:31 +1000 X-BeenThere: linuxppc-dev@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Linux on PowerPC Developers Mail List List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: sathyanarayanan.kuppuswamy@linux.intel.com Errors-To: linuxppc-dev-bounces+linuxppc-dev=archiver.kernel.org@lists.ozlabs.org Sender: "Linuxppc-dev" On 8/27/19 8:18 AM, Andy Shevchenko wrote: > Kernel-doc validator complains: > > aer.c:207: warning: Function parameter or member 'str' not described in 'pcie_ecrc_get_policy' > aer.c:1209: warning: Function parameter or member 'irq' not described in 'aer_isr' > aer.c:1209: warning: Function parameter or member 'context' not described in 'aer_isr' > aer.c:1209: warning: Excess function parameter 'work' description in 'aer_isr' > > Fix the above accordingly. > > Signed-off-by: Andy Shevchenko Reviewed-by: Kuppuswamy Sathyanarayanan > --- > drivers/pci/pcie/aer.c | 4 +++- > 1 file changed, 3 insertions(+), 1 deletion(-) > > diff --git a/drivers/pci/pcie/aer.c b/drivers/pci/pcie/aer.c > index f883f81d759a..6073eaab099d 100644 > --- a/drivers/pci/pcie/aer.c > +++ b/drivers/pci/pcie/aer.c > @@ -202,6 +202,7 @@ void pcie_set_ecrc_checking(struct pci_dev *dev) > > /** > * pcie_ecrc_get_policy - parse kernel command-line ecrc option > + * @str: ECRC policy from kernel command line to use > */ > void pcie_ecrc_get_policy(char *str) > { > @@ -1201,7 +1202,8 @@ static void aer_isr_one_error(struct aer_rpc *rpc, > > /** > * aer_isr - consume errors detected by root port > - * @work: definition of this work item > + * @irq: IRQ assigned to Root Port > + * @context: pointer to Root Port data structure > * > * Invoked, as DPC, when root port records new detected error > */ -- Sathyanarayanan Kuppuswamy Linux kernel developer