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=-17.2 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS 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 26F41C433F5 for ; Mon, 20 Sep 2021 16:19:03 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (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 E00DA61163 for ; Mon, 20 Sep 2021 16:19:02 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org E00DA61163 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linuxfoundation.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 3A83D6E573; Mon, 20 Sep 2021 16:19:02 +0000 (UTC) Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by gabe.freedesktop.org (Postfix) with ESMTPS id 5BA276E570 for ; Mon, 20 Sep 2021 16:19:01 +0000 (UTC) Received: by mail.kernel.org (Postfix) with ESMTPSA id AF53360F58; Mon, 20 Sep 2021 16:19:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=linuxfoundation.org; s=korg; t=1632154741; bh=6FXC88wf88wJ4eN94yjBPS1MhEcuAcGvbrDrhF4661Q=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=VPEt4qHe5Df4DBjv69PbMTy38I7DHRiJVY9NoJxisCWih4NZ0/YzgfwsmQMqTGJ3C kqCiZvkbdlCeVkZbApXNgWMlH5sXlmY4mKI001CxbU0fM30CZjwACXcqO6q3dVoSRt gKsQCTEDbYqCAwjDCmmFoSff4LBzslBO25x2NfrQ= Date: Mon, 20 Sep 2021 18:18:58 +0200 From: Greg KH To: Zachary Mayhew Cc: dri-devel@lists.freedesktop.org, linux-fbdev@lists.kernel.org, linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org Subject: Re: [PATCH] staging: fbtft: add docs for fbtft_write_spi() Message-ID: References: <20210920152601.170453-1-zacklukem.kernel@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" On Mon, Sep 20, 2021 at 09:07:13AM -0700, Zachary Mayhew wrote: > On Mon, Sep 20, 2021 at 05:38:30PM +0200, Greg KH wrote: > > On Mon, Sep 20, 2021 at 08:26:03AM -0700, Zachary Mayhew wrote: > > > Subject: [PATCH] staging: fbtft: add docs for fbtft_write_spi() > > > > Odd, this shouldn't be in the body of the email :( > > > > > > > > This patch adds documentation for fbtft_write_spi() to make its > > > calling context clear and explain what it does. > > > > > > Signed-off-by: Zachary Mayhew > > > --- > > > drivers/staging/fbtft/fbtft-io.c | 13 +++++++++++++ > > > 1 file changed, 13 insertions(+) > > > > > > diff --git a/drivers/staging/fbtft/fbtft-io.c b/drivers/staging/fbtft/fbtft-io.c > > > index de1904a443c2..985d7cf8c774 100644 > > > --- a/drivers/staging/fbtft/fbtft-io.c > > > +++ b/drivers/staging/fbtft/fbtft-io.c > > > @@ -5,6 +5,19 @@ > > > #include > > > #include "fbtft.h" > > > > > > +/** > > > + * fbtft_write_spi() - write data to current spi > > > + * @par: Driver data including driver &struct spi_device > > > + * @buf: Buffer to write to spi > > > + * @len: Length of the buffer > > > + * Context: can sleep > > > + * > > > + * Builds an &struct spi_transfer and &struct spi_message object based on the > > > + * given @buf and @len. These are then used in a call to spi_sync() which will > > > + * write to the spi. > > > + * > > > + * Return: zero on success or else a negative error code > > > + */ > > > int fbtft_write_spi(struct fbtft_par *par, void *buf, size_t len) > > > { > > > struct spi_transfer t = { > > > -- > > > 2.33.0 > > > > > > > > > > Is this file being imported into the kernel doc tools? If so, great, if > > not, this isn't going to help out all that much, right? > > It doesn't appear to be imported at this time, as such it may not be > necessary. So is this change needed? thanks, greg k-h