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=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 8FFB9C433F5 for ; Mon, 20 Sep 2021 15:38:37 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 7538F61175 for ; Mon, 20 Sep 2021 15:38:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241957AbhITPkC (ORCPT ); Mon, 20 Sep 2021 11:40:02 -0400 Received: from mail.kernel.org ([198.145.29.99]:33900 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S241893AbhITPj7 (ORCPT ); Mon, 20 Sep 2021 11:39:59 -0400 Received: by mail.kernel.org (Postfix) with ESMTPSA id 44574610A3; Mon, 20 Sep 2021 15:38:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=linuxfoundation.org; s=korg; t=1632152312; bh=1F3PXoFKRyGnJqNMxiWHzpAQJEH6bcpzvzx6prYefJY=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=RRnLU2c43xT85EkPdNm3NvkiUBO+VqlS66Lnqun+4zb5p+7XEZQMRI/eCQnnyw5rI H1imqK+04Nj2N9CFF8oyU6OL+P0F9AlTe9ym9KmoXmAYRC1etcXIBATKD+k9aQdTk1 CiO9k09jqhfN+LSBvZtDPdQdQ+1bRLpG9JxBl8oI= Date: Mon, 20 Sep 2021 17:38:30 +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: <20210920152601.170453-1-zacklukem.kernel@gmail.com> Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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? thanks, greg k-h