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=-7.0 required=3.0 tests=DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED,DKIM_VALID,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=ham 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 B5A9BC433DF for ; Mon, 29 Jun 2020 15:01:23 +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 83B2823E53 for ; Mon, 29 Jun 2020 15:01:23 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="cdCNLqCr"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="Pe1X843T" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 83B2823E53 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.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:To:Subject:Message-ID:Date:From:In-Reply-To: References:MIME-Version:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=M06FPyd//Uuduh/KWQGMN9oCJhGT3REHV6uLBzpB1BA=; b=cdCNLqCr9gY1lsL5jQcPUClT8 MGPzS90jnm2mpZb5b/Y6ymoqAYMKE7P245qT8hOwVuIygbUUlF8lydJSljMaYTUOuONjC/QsTqOTS tgUa1/NA+CkaDTnXsyDw0F74H1ixduhuzrUkUNbFIOXDSws6iOu+6elR/bGxGIHIELgSvUtlobEPv VQZBVUeHRo187OK2ioR9Oprpyziur6k77RY354LmXubiNK6CXDnt/zTpVBwbsiYwnT6thBToex2eL Nox/P53Uw1F0cb/qkME8p0BVxR5NEiCT6MXwNeI0ML99L20YZRwX1D7LWfQhYnsxNjFypjWXbHF3Q kd5oRr/bg==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jpvGB-0007qy-WF; Mon, 29 Jun 2020 14:59:52 +0000 Received: from mail-ot1-x343.google.com ([2607:f8b0:4864:20::343]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jpvG9-0007pz-NB for linux-arm-kernel@lists.infradead.org; Mon, 29 Jun 2020 14:59:50 +0000 Received: by mail-ot1-x343.google.com with SMTP id t18so2976547otq.5 for ; Mon, 29 Jun 2020 07:59:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=O9Y/+e/e29D9znyzVTDfGPWcbDE2sgU04HkRdXVP2Y0=; b=Pe1X843TCcJC8mG7AsPGFWzJt/6SM1sl85DIfk19L1KrVD6knekTW4seEvRud51YLG yF9aKcbBg4q775aYOUzlkGAEJOOOKRiyuBwuilfm4pPJIUy3YX/pmL/EAGHifRbCyiJq k3FQUeAHHiajm2816UP4/LUgQgs/2o4zcgAYmf9l28dk5cUNyniMVkGWO1vxa6IShY/S pO1B9AxL0HEbQeut+iS4tR4xrH+F+Df/XvWpU4Erj+xwyJzWZWqIbFAIJuInnq9P1U+g FKrIUvKc+LBQf2TFAwHy/02dsywvHZkFa6sDSr5r6rYstA7KtHHXW06HvIlHVuk20on5 ycjQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=O9Y/+e/e29D9znyzVTDfGPWcbDE2sgU04HkRdXVP2Y0=; b=O18gGZdF7fBlyJ8JlgMp/Bxiqdk1WrR1jgDjj8GTcAtSk3nhik88AqiEHSuXBLtsBm j3qW2A/z9fJUyWNQOcpHCwUqUfre+V8dpt9Y4bt9OZwy8K48FvU9eNudcgzMODZVg0+T JpvYq6kjzNcLRVvVzXHz2DBf0eX7BHyQ7MSjvfBW76sD5/ik2j3C2wSgQLjvkhNqnDKk r76NjUVE7RVSODWz3Q2d+tEcBVFzTSlzrm2RJqIXR0ccqKPn8BSc1vH/UXgcF4C8szQY VIQu3XmQCcnq3U1oXktvfOL7IXTgF1cos55R9OrmSjJAizXEgl24RuXVrEu8QvgDMPRa nHeQ== X-Gm-Message-State: AOAM532YLZbdxbpoFUZ1L0lRexwB23jkmfgWuYRdownDXBdU9r2f247E SQSKw3PPMbVVZgLhn9bDuGog5QPUR+67d9J+gRjoadvH X-Google-Smtp-Source: ABdhPJxlHj+j8ZYs6uJnfSfCiAx17n4DDEDtLjPmb8ihqGFXQe3xIjU2VD3uRKFJGZJB9fzSwltqlI9xmBA20MbcoMU= X-Received: by 2002:a4a:dfb5:: with SMTP id k21mr6039768ook.27.1593442787765; Mon, 29 Jun 2020 07:59:47 -0700 (PDT) MIME-Version: 1.0 References: <20200629140442.1043957-1-lee.jones@linaro.org> <20200629140442.1043957-6-lee.jones@linaro.org> In-Reply-To: <20200629140442.1043957-6-lee.jones@linaro.org> From: Oded Gabbay Date: Mon, 29 Jun 2020 17:59:19 +0300 Message-ID: Subject: Re: [PATCH 05/20] misc: habanalabs: irq: Repair kerneldoc formatting issues To: Lee Jones 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: Greg Kroah-Hartman , Tomer Tayar , linux-arm-kernel@lists.infradead.org, Arnd Bergmann , "Linux-Kernel@Vger. Kernel. Org" Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Mon, Jun 29, 2020 at 5:04 PM Lee Jones wrote: > > 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. > > While we're here, the headers for functions various functions > were written in kerneldoc format, but lack the kerneldoc > identifier '/**'. Let's promote them so they can gain access > to the checker. > > This change fixes the following W=1 warnings: > > drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'eq_work' not described in 'hl_eqe_work' > drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'hdev' not described in 'hl_eqe_work' > drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'eq_entry' not described in 'hl_eqe_work' > > Cc: Oded Gabbay > Cc: Tomer Tayar > Signed-off-by: Lee Jones > --- > drivers/misc/habanalabs/irq.c | 22 +++++++++++----------- > 1 file changed, 11 insertions(+), 11 deletions(-) > > diff --git a/drivers/misc/habanalabs/irq.c b/drivers/misc/habanalabs/irq.c > index 4e77a73857793..6981d67153b11 100644 > --- a/drivers/misc/habanalabs/irq.c > +++ b/drivers/misc/habanalabs/irq.c > @@ -13,9 +13,9 @@ > * struct hl_eqe_work - This structure is used to schedule work of EQ > * entry and armcp_reset event > * > - * @eq_work - workqueue object to run when EQ entry is received > - * @hdev - pointer to device structure > - * @eq_entry - copy of the EQ entry > + * @eq_work: workqueue object to run when EQ entry is received > + * @hdev: pointer to device structure > + * @eq_entry: copy of the EQ entry > */ > struct hl_eqe_work { > struct work_struct eq_work; > @@ -23,7 +23,7 @@ struct hl_eqe_work { > struct hl_eq_entry eq_entry; > }; > > -/* > +/** > * hl_cq_inc_ptr - increment ci or pi of cq > * > * @ptr: the current ci or pi value of the completion queue > @@ -39,7 +39,7 @@ inline u32 hl_cq_inc_ptr(u32 ptr) > return ptr; > } > > -/* > +/** > * hl_eq_inc_ptr - increment ci of eq > * > * @ptr: the current ci value of the event queue > @@ -66,7 +66,7 @@ static void irq_handle_eqe(struct work_struct *work) > kfree(eqe_work); > } > > -/* > +/** > * hl_irq_handler_cq - irq handler for completion queue > * > * @irq: irq number > @@ -142,7 +142,7 @@ irqreturn_t hl_irq_handler_cq(int irq, void *arg) > return IRQ_HANDLED; > } > > -/* > +/** > * hl_irq_handler_eq - irq handler for event queue > * > * @irq: irq number > @@ -206,7 +206,7 @@ irqreturn_t hl_irq_handler_eq(int irq, void *arg) > return IRQ_HANDLED; > } > > -/* > +/** > * hl_cq_init - main initialization function for an cq object > * > * @hdev: pointer to device structure > @@ -238,7 +238,7 @@ int hl_cq_init(struct hl_device *hdev, struct hl_cq *q, u32 hw_queue_id) > return 0; > } > > -/* > +/** > * hl_cq_fini - destroy completion queue > * > * @hdev: pointer to device structure > @@ -269,7 +269,7 @@ void hl_cq_reset(struct hl_device *hdev, struct hl_cq *q) > memset((void *) (uintptr_t) q->kernel_address, 0, HL_CQ_SIZE_IN_BYTES); > } > > -/* > +/** > * hl_eq_init - main initialization function for an event queue object > * > * @hdev: pointer to device structure > @@ -297,7 +297,7 @@ int hl_eq_init(struct hl_device *hdev, struct hl_eq *q) > return 0; > } > > -/* > +/** > * hl_eq_fini - destroy event queue > * > * @hdev: pointer to device structure > -- > 2.25.1 > This patch is: Reviewed-by: Oded Gabbay _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel