From mboxrd@z Thu Jan 1 00:00:00 1970 From: Lee Jones Date: Thu, 25 Jun 2020 10:33:34 +0000 Subject: Re: [PATCH 3/8] backlight: ili922x: Add missing kerneldoc descriptions for CHECK_FREQ_REG() args Message-Id: <20200625103334.GO954398@dell> List-Id: References: <20200624145721.2590327-1-lee.jones@linaro.org> <20200624145721.2590327-4-lee.jones@linaro.org> <20200625094051.u4hanl3rycczlwiy@holly.lan> In-Reply-To: <20200625094051.u4hanl3rycczlwiy@holly.lan> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit To: Daniel Thompson Cc: linux-fbdev@vger.kernel.org, Bartlomiej Zolnierkiewicz , jingoohan1@gmail.com, linux-kernel@vger.kernel.org, stable@vger.kernel.org, dri-devel@lists.freedesktop.org, Software Engineering , linux-arm-kernel@lists.infradead.org On Thu, 25 Jun 2020, Daniel Thompson wrote: > On Wed, Jun 24, 2020 at 03:57:16PM +0100, Lee Jones wrote: > > Kerneldoc syntax is used, but not complete. Descriptions required. > > > > Prevents warnings like: > > > > drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 's' not described in 'CHECK_FREQ_REG' > > drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 'x' not described in 'CHECK_FREQ_REG' > > > > Cc: > > Cc: Bartlomiej Zolnierkiewicz > > Cc: Software Engineering > > Signed-off-by: Lee Jones > > --- > > drivers/video/backlight/ili922x.c | 2 ++ > > 1 file changed, 2 insertions(+) > > > > diff --git a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c > > index 9c5aa3fbb2842..8cb4b9d3c3bba 100644 > > --- a/drivers/video/backlight/ili922x.c > > +++ b/drivers/video/backlight/ili922x.c > > @@ -107,6 +107,8 @@ > > * lower frequency when the registers are read/written. > > * The macro sets the frequency in the spi_transfer structure if > > * the frequency exceeds the maximum value. > > + * @s: pointer to controller side proxy for an SPI slave device > > What's wrong with "a pointer to an SPI device"? > > I am aware, having looked it up to find out what the above actually > means, that this is how struct spi_device is described in its own kernel > doc but quoting at that level of detail of both overkill and confusing. I figured that using the official description would be better than making something up. However if you think it's better to KISS, then I can change it. -- Lee Jones [李琼斯] Senior Technical Lead - Developer Services Linaro.org │ Open source software for Arm SoCs Follow Linaro: Facebook | Twitter | Blog 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=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED 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 8C931C433E1 for ; Thu, 25 Jun 2020 10:35:29 +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 5F79F2063A for ; Thu, 25 Jun 2020 10:35:29 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="QG4wx14K"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="ckSbRH6Y" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 5F79F2063A 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+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:In-Reply-To:MIME-Version:References:Message-ID: Subject:To:From:Date:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=NwJJjMotQcc3XfRofdxs4yAGGCGHsYP2+tkaVCgXdeg=; b=QG4wx14KJV8mU/pRgJe7REnlG Cv685nXHZV3hBWG3t0mSuRlcC8dKbtSOGgSiAHkqHYOi6TrJ85+enBIq3IWDJamvbQfkXDAr4aM6P 39hy4jtou5mUe5sxrCaqL2lA8Go51AjEo3rW3pDFrL8lmLKjPculpn0TWsZbUKHcPLEdCQxqhoNe4 YU3GofG3SHGTYy1r02uWmQuDYOt9fIpFvr9mmHTYlMRR7TJ27tp4DJUI1UCQx2l1uAnElpXTSKThQ xST98RJ032i89VuMxf5IxLlKKVsgn8nQu5eMizqnoJN3dXVxT0IoIXnC3SOKWaC9vJ8XMeisVsNlD VpLvQbHWw==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1joPCP-0004o0-30; Thu, 25 Jun 2020 10:33:41 +0000 Received: from mail-wm1-x342.google.com ([2a00:1450:4864:20::342]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1joPCM-0004ng-IX for linux-arm-kernel@lists.infradead.org; Thu, 25 Jun 2020 10:33:39 +0000 Received: by mail-wm1-x342.google.com with SMTP id l17so5054093wmj.0 for ; Thu, 25 Jun 2020 03:33:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:content-transfer-encoding:in-reply-to; bh=cwS7iBZ35KlWA6jBEXe+RY7hU/oltm4mf+ZLVTmBHbg=; b=ckSbRH6Y9xOKw8TwFf5S6Fhk1vOPMMffz1PvAsd5fQkuEUwGeqv8ZMfu7b4VseJXq+ Q+Zwl6jtJPG6b8nC0vUNjXsuJBAHkcblkb0pQgjxdlrWuvAO3vVH5EOdN8ykR1fFNkO2 0Y3+9hQyIHdmKpwtONksi/eq/d8zwBaAwnMZiCl2cMapDRa21bVFWnrvJmrLcOy/lGA5 r1jIAR/pLarr4nRMPCFRPDiBFXE3KVAPa2+iPKV0c4lCbi24fnFNTvU8a5C/BFnrqmFF NBvqmgslp9dIo5O2WX8S0qZbHFB5FnOKAffE3NigkrXiKcASZlQGDfgOFNp/1b16IVxq irbw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:content-transfer-encoding :in-reply-to; bh=cwS7iBZ35KlWA6jBEXe+RY7hU/oltm4mf+ZLVTmBHbg=; b=jFGKLfMZ2b+D0g9BgRweAlgVr9z800ww9/f8HudnAedS68ggwuwXIP0RyXLOLJ0ZjJ AAYoJDKFOV+oLB5fa+TVDxnl8Zzn7qmc2i8Y9cbwBGeKJIxOlLRyjq/y9M/V+NTGlMDK pjr3Nvlecog2wAydmHtWBvKUSD0S2Oyz8vnEgul3XLIrmihHsxLujWTQFC/IDUNuzqZ5 MR76OxCeiJd6F4Qx021XuXD9qBodxW3EyZ1psHmKEFMs8EotMD7LjecLA0JhDqoHSR9I 6KJkIfXGyjvAaxVVdUAG9h/sSzw2tvMXe9/jfrrlKuT2UG1/M2XDer4uXG1UjEKvOrCp HOCA== X-Gm-Message-State: AOAM530JqAfjHGqGxyfPK0dWqcwFpe42J9t6MSTAQpLoANg6m6Y9PJKo Gxvw74h+lpSug/sD7v02sB0MZg== X-Google-Smtp-Source: ABdhPJxRQCCMvNxIjXjxszNKanKw0pTi4YzKhm6dZatNk1oJ81au17V7nolB179hYdVcODuntoi7tQ== X-Received: by 2002:a7b:ce97:: with SMTP id q23mr2641581wmj.89.1593081217260; Thu, 25 Jun 2020 03:33:37 -0700 (PDT) Received: from dell ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id t4sm5852497wmf.4.2020.06.25.03.33.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Jun 2020 03:33:36 -0700 (PDT) Date: Thu, 25 Jun 2020 11:33:34 +0100 From: Lee Jones To: Daniel Thompson Subject: Re: [PATCH 3/8] backlight: ili922x: Add missing kerneldoc descriptions for CHECK_FREQ_REG() args Message-ID: <20200625103334.GO954398@dell> References: <20200624145721.2590327-1-lee.jones@linaro.org> <20200624145721.2590327-4-lee.jones@linaro.org> <20200625094051.u4hanl3rycczlwiy@holly.lan> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20200625094051.u4hanl3rycczlwiy@holly.lan> 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: linux-fbdev@vger.kernel.org, Bartlomiej Zolnierkiewicz , jingoohan1@gmail.com, linux-kernel@vger.kernel.org, stable@vger.kernel.org, dri-devel@lists.freedesktop.org, Software Engineering , linux-arm-kernel@lists.infradead.org Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org T24gVGh1LCAyNSBKdW4gMjAyMCwgRGFuaWVsIFRob21wc29uIHdyb3RlOgoKPiBPbiBXZWQsIEp1 biAyNCwgMjAyMCBhdCAwMzo1NzoxNlBNICswMTAwLCBMZWUgSm9uZXMgd3JvdGU6Cj4gPiBLZXJu ZWxkb2Mgc3ludGF4IGlzIHVzZWQsIGJ1dCBub3QgY29tcGxldGUuICBEZXNjcmlwdGlvbnMgcmVx dWlyZWQuCj4gPiAKPiA+IFByZXZlbnRzIHdhcm5pbmdzIGxpa2U6Cj4gPiAKPiA+ICBkcml2ZXJz L3ZpZGVvL2JhY2tsaWdodC9pbGk5MjJ4LmM6MTE2OiB3YXJuaW5nOiBGdW5jdGlvbiBwYXJhbWV0 ZXIgb3IgbWVtYmVyICdzJyBub3QgZGVzY3JpYmVkIGluICdDSEVDS19GUkVRX1JFRycKPiA+ICBk cml2ZXJzL3ZpZGVvL2JhY2tsaWdodC9pbGk5MjJ4LmM6MTE2OiB3YXJuaW5nOiBGdW5jdGlvbiBw YXJhbWV0ZXIgb3IgbWVtYmVyICd4JyBub3QgZGVzY3JpYmVkIGluICdDSEVDS19GUkVRX1JFRycK PiA+IAo+ID4gQ2M6IDxzdGFibGVAdmdlci5rZXJuZWwub3JnPgo+ID4gQ2M6IEJhcnRsb21pZWog Wm9sbmllcmtpZXdpY3ogPGIuem9sbmllcmtpZUBzYW1zdW5nLmNvbT4KPiA+IENjOiBTb2Z0d2Fy ZSBFbmdpbmVlcmluZyA8c2JhYmljQGRlbnguZGU+Cj4gPiBTaWduZWQtb2ZmLWJ5OiBMZWUgSm9u ZXMgPGxlZS5qb25lc0BsaW5hcm8ub3JnPgo+ID4gLS0tCj4gPiAgZHJpdmVycy92aWRlby9iYWNr bGlnaHQvaWxpOTIyeC5jIHwgMiArKwo+ID4gIDEgZmlsZSBjaGFuZ2VkLCAyIGluc2VydGlvbnMo KykKPiA+IAo+ID4gZGlmZiAtLWdpdCBhL2RyaXZlcnMvdmlkZW8vYmFja2xpZ2h0L2lsaTkyMngu YyBiL2RyaXZlcnMvdmlkZW8vYmFja2xpZ2h0L2lsaTkyMnguYwo+ID4gaW5kZXggOWM1YWEzZmJi Mjg0Mi4uOGNiNGI5ZDNjM2JiYSAxMDA2NDQKPiA+IC0tLSBhL2RyaXZlcnMvdmlkZW8vYmFja2xp Z2h0L2lsaTkyMnguYwo+ID4gKysrIGIvZHJpdmVycy92aWRlby9iYWNrbGlnaHQvaWxpOTIyeC5j Cj4gPiBAQCAtMTA3LDYgKzEwNyw4IEBACj4gPiAgICoJbG93ZXIgZnJlcXVlbmN5IHdoZW4gdGhl IHJlZ2lzdGVycyBhcmUgcmVhZC93cml0dGVuLgo+ID4gICAqCVRoZSBtYWNybyBzZXRzIHRoZSBm cmVxdWVuY3kgaW4gdGhlIHNwaV90cmFuc2ZlciBzdHJ1Y3R1cmUgaWYKPiA+ICAgKgl0aGUgZnJl cXVlbmN5IGV4Y2VlZHMgdGhlIG1heGltdW0gdmFsdWUuCj4gPiArICogQHM6IHBvaW50ZXIgdG8g Y29udHJvbGxlciBzaWRlIHByb3h5IGZvciBhbiBTUEkgc2xhdmUgZGV2aWNlCj4gCj4gV2hhdCdz IHdyb25nIHdpdGggImEgcG9pbnRlciB0byBhbiBTUEkgZGV2aWNlIj8KPiAKPiBJIGFtIGF3YXJl LCBoYXZpbmcgbG9va2VkIGl0IHVwIHRvIGZpbmQgb3V0IHdoYXQgdGhlIGFib3ZlIGFjdHVhbGx5 Cj4gbWVhbnMsIHRoYXQgdGhpcyBpcyBob3cgc3RydWN0IHNwaV9kZXZpY2UgaXMgZGVzY3JpYmVk IGluIGl0cyBvd24ga2VybmVsCj4gZG9jIGJ1dCBxdW90aW5nIGF0IHRoYXQgbGV2ZWwgb2YgZGV0 YWlsIG9mIGJvdGggb3ZlcmtpbGwgYW5kIGNvbmZ1c2luZy4KCkkgZmlndXJlZCB0aGF0IHVzaW5n IHRoZSBvZmZpY2lhbCBkZXNjcmlwdGlvbiB3b3VsZCBiZSBiZXR0ZXIgdGhhbgptYWtpbmcgc29t ZXRoaW5nIHVwLiAgSG93ZXZlciBpZiB5b3UgdGhpbmsgaXQncyBiZXR0ZXIgdG8gS0lTUywgdGhl biBJCmNhbiBjaGFuZ2UgaXQuCgotLSAKTGVlIEpvbmVzIFvmnY7nkLzmlq9dClNlbmlvciBUZWNo bmljYWwgTGVhZCAtIERldmVsb3BlciBTZXJ2aWNlcwpMaW5hcm8ub3JnIOKUgiBPcGVuIHNvdXJj ZSBzb2Z0d2FyZSBmb3IgQXJtIFNvQ3MKRm9sbG93IExpbmFybzogRmFjZWJvb2sgfCBUd2l0dGVy IHwgQmxvZwoKX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18K bGludXgtYXJtLWtlcm5lbCBtYWlsaW5nIGxpc3QKbGludXgtYXJtLWtlcm5lbEBsaXN0cy5pbmZy YWRlYWQub3JnCmh0dHA6Ly9saXN0cy5pbmZyYWRlYWQub3JnL21haWxtYW4vbGlzdGluZm8vbGlu dXgtYXJtLWtlcm5lbAo= 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=-6.8 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, 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 407AAC433E0 for ; Thu, 25 Jun 2020 10:33:40 +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 130472053B for ; Thu, 25 Jun 2020 10:33:40 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="ckSbRH6Y" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 130472053B Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=dri-devel-bounces@lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 88F216EA43; Thu, 25 Jun 2020 10:33:39 +0000 (UTC) Received: from mail-wm1-x341.google.com (mail-wm1-x341.google.com [IPv6:2a00:1450:4864:20::341]) by gabe.freedesktop.org (Postfix) with ESMTPS id C5C346EA43 for ; Thu, 25 Jun 2020 10:33:38 +0000 (UTC) Received: by mail-wm1-x341.google.com with SMTP id q15so5034902wmj.2 for ; Thu, 25 Jun 2020 03:33:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:content-transfer-encoding:in-reply-to; bh=cwS7iBZ35KlWA6jBEXe+RY7hU/oltm4mf+ZLVTmBHbg=; b=ckSbRH6Y9xOKw8TwFf5S6Fhk1vOPMMffz1PvAsd5fQkuEUwGeqv8ZMfu7b4VseJXq+ Q+Zwl6jtJPG6b8nC0vUNjXsuJBAHkcblkb0pQgjxdlrWuvAO3vVH5EOdN8ykR1fFNkO2 0Y3+9hQyIHdmKpwtONksi/eq/d8zwBaAwnMZiCl2cMapDRa21bVFWnrvJmrLcOy/lGA5 r1jIAR/pLarr4nRMPCFRPDiBFXE3KVAPa2+iPKV0c4lCbi24fnFNTvU8a5C/BFnrqmFF NBvqmgslp9dIo5O2WX8S0qZbHFB5FnOKAffE3NigkrXiKcASZlQGDfgOFNp/1b16IVxq irbw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:content-transfer-encoding :in-reply-to; bh=cwS7iBZ35KlWA6jBEXe+RY7hU/oltm4mf+ZLVTmBHbg=; b=HBsTHHtUYLlP0l+Jb1yMXN8UFa3Gtpw+50UkNRRTBqy8RblPTlrirybMewAoCNlhxe d+Y7EQ4qDYr8hafWZvVtWA2Sk0SA6O4WghqFGLg7cu1B64xxZQ+OaBakpwcaEW8p0xG2 5ke1j0WJAFVRz/yof6MJBlVCorpfl7yWVh/SdgKoagddKVsai3nGLcH8gSJNtsqbFjqK Unj170pZA9WnlXPE61udJhGfsUXEi7rZv+1m/HVuF9hL/Z+xKYSGhyqQaeS/p6Aowyvb Ix86Oopt7DGE181QU1PQd8LqP6vaQA73SgFJI4M/FgiPFy7KyjZ+xMhXnL6X7IRYO/TG 2Gcw== X-Gm-Message-State: AOAM5319NWwWSk+pFdT8onBloFSLaPKbN8HqPiPU6SYK4jBrNy/ytNdh IORk0NYf3rg36HbgXdjl6uIirw== X-Google-Smtp-Source: ABdhPJxRQCCMvNxIjXjxszNKanKw0pTi4YzKhm6dZatNk1oJ81au17V7nolB179hYdVcODuntoi7tQ== X-Received: by 2002:a7b:ce97:: with SMTP id q23mr2641581wmj.89.1593081217260; Thu, 25 Jun 2020 03:33:37 -0700 (PDT) Received: from dell ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id t4sm5852497wmf.4.2020.06.25.03.33.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Jun 2020 03:33:36 -0700 (PDT) Date: Thu, 25 Jun 2020 11:33:34 +0100 From: Lee Jones To: Daniel Thompson Subject: Re: [PATCH 3/8] backlight: ili922x: Add missing kerneldoc descriptions for CHECK_FREQ_REG() args Message-ID: <20200625103334.GO954398@dell> References: <20200624145721.2590327-1-lee.jones@linaro.org> <20200624145721.2590327-4-lee.jones@linaro.org> <20200625094051.u4hanl3rycczlwiy@holly.lan> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20200625094051.u4hanl3rycczlwiy@holly.lan> 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: , Cc: linux-fbdev@vger.kernel.org, Bartlomiej Zolnierkiewicz , jingoohan1@gmail.com, linux-kernel@vger.kernel.org, stable@vger.kernel.org, dri-devel@lists.freedesktop.org, Software Engineering , linux-arm-kernel@lists.infradead.org Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" T24gVGh1LCAyNSBKdW4gMjAyMCwgRGFuaWVsIFRob21wc29uIHdyb3RlOgoKPiBPbiBXZWQsIEp1 biAyNCwgMjAyMCBhdCAwMzo1NzoxNlBNICswMTAwLCBMZWUgSm9uZXMgd3JvdGU6Cj4gPiBLZXJu ZWxkb2Mgc3ludGF4IGlzIHVzZWQsIGJ1dCBub3QgY29tcGxldGUuICBEZXNjcmlwdGlvbnMgcmVx dWlyZWQuCj4gPiAKPiA+IFByZXZlbnRzIHdhcm5pbmdzIGxpa2U6Cj4gPiAKPiA+ICBkcml2ZXJz L3ZpZGVvL2JhY2tsaWdodC9pbGk5MjJ4LmM6MTE2OiB3YXJuaW5nOiBGdW5jdGlvbiBwYXJhbWV0 ZXIgb3IgbWVtYmVyICdzJyBub3QgZGVzY3JpYmVkIGluICdDSEVDS19GUkVRX1JFRycKPiA+ICBk cml2ZXJzL3ZpZGVvL2JhY2tsaWdodC9pbGk5MjJ4LmM6MTE2OiB3YXJuaW5nOiBGdW5jdGlvbiBw YXJhbWV0ZXIgb3IgbWVtYmVyICd4JyBub3QgZGVzY3JpYmVkIGluICdDSEVDS19GUkVRX1JFRycK PiA+IAo+ID4gQ2M6IDxzdGFibGVAdmdlci5rZXJuZWwub3JnPgo+ID4gQ2M6IEJhcnRsb21pZWog Wm9sbmllcmtpZXdpY3ogPGIuem9sbmllcmtpZUBzYW1zdW5nLmNvbT4KPiA+IENjOiBTb2Z0d2Fy ZSBFbmdpbmVlcmluZyA8c2JhYmljQGRlbnguZGU+Cj4gPiBTaWduZWQtb2ZmLWJ5OiBMZWUgSm9u ZXMgPGxlZS5qb25lc0BsaW5hcm8ub3JnPgo+ID4gLS0tCj4gPiAgZHJpdmVycy92aWRlby9iYWNr bGlnaHQvaWxpOTIyeC5jIHwgMiArKwo+ID4gIDEgZmlsZSBjaGFuZ2VkLCAyIGluc2VydGlvbnMo KykKPiA+IAo+ID4gZGlmZiAtLWdpdCBhL2RyaXZlcnMvdmlkZW8vYmFja2xpZ2h0L2lsaTkyMngu YyBiL2RyaXZlcnMvdmlkZW8vYmFja2xpZ2h0L2lsaTkyMnguYwo+ID4gaW5kZXggOWM1YWEzZmJi Mjg0Mi4uOGNiNGI5ZDNjM2JiYSAxMDA2NDQKPiA+IC0tLSBhL2RyaXZlcnMvdmlkZW8vYmFja2xp Z2h0L2lsaTkyMnguYwo+ID4gKysrIGIvZHJpdmVycy92aWRlby9iYWNrbGlnaHQvaWxpOTIyeC5j Cj4gPiBAQCAtMTA3LDYgKzEwNyw4IEBACj4gPiAgICoJbG93ZXIgZnJlcXVlbmN5IHdoZW4gdGhl IHJlZ2lzdGVycyBhcmUgcmVhZC93cml0dGVuLgo+ID4gICAqCVRoZSBtYWNybyBzZXRzIHRoZSBm cmVxdWVuY3kgaW4gdGhlIHNwaV90cmFuc2ZlciBzdHJ1Y3R1cmUgaWYKPiA+ICAgKgl0aGUgZnJl cXVlbmN5IGV4Y2VlZHMgdGhlIG1heGltdW0gdmFsdWUuCj4gPiArICogQHM6IHBvaW50ZXIgdG8g Y29udHJvbGxlciBzaWRlIHByb3h5IGZvciBhbiBTUEkgc2xhdmUgZGV2aWNlCj4gCj4gV2hhdCdz IHdyb25nIHdpdGggImEgcG9pbnRlciB0byBhbiBTUEkgZGV2aWNlIj8KPiAKPiBJIGFtIGF3YXJl LCBoYXZpbmcgbG9va2VkIGl0IHVwIHRvIGZpbmQgb3V0IHdoYXQgdGhlIGFib3ZlIGFjdHVhbGx5 Cj4gbWVhbnMsIHRoYXQgdGhpcyBpcyBob3cgc3RydWN0IHNwaV9kZXZpY2UgaXMgZGVzY3JpYmVk IGluIGl0cyBvd24ga2VybmVsCj4gZG9jIGJ1dCBxdW90aW5nIGF0IHRoYXQgbGV2ZWwgb2YgZGV0 YWlsIG9mIGJvdGggb3ZlcmtpbGwgYW5kIGNvbmZ1c2luZy4KCkkgZmlndXJlZCB0aGF0IHVzaW5n IHRoZSBvZmZpY2lhbCBkZXNjcmlwdGlvbiB3b3VsZCBiZSBiZXR0ZXIgdGhhbgptYWtpbmcgc29t ZXRoaW5nIHVwLiAgSG93ZXZlciBpZiB5b3UgdGhpbmsgaXQncyBiZXR0ZXIgdG8gS0lTUywgdGhl biBJCmNhbiBjaGFuZ2UgaXQuCgotLSAKTGVlIEpvbmVzIFvmnY7nkLzmlq9dClNlbmlvciBUZWNo bmljYWwgTGVhZCAtIERldmVsb3BlciBTZXJ2aWNlcwpMaW5hcm8ub3JnIOKUgiBPcGVuIHNvdXJj ZSBzb2Z0d2FyZSBmb3IgQXJtIFNvQ3MKRm9sbG93IExpbmFybzogRmFjZWJvb2sgfCBUd2l0dGVy IHwgQmxvZwpfX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fXwpk cmktZGV2ZWwgbWFpbGluZyBsaXN0CmRyaS1kZXZlbEBsaXN0cy5mcmVlZGVza3RvcC5vcmcKaHR0 cHM6Ly9saXN0cy5mcmVlZGVza3RvcC5vcmcvbWFpbG1hbi9saXN0aW5mby9kcmktZGV2ZWwK 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.1 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED 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 BD007C433E2 for ; Thu, 25 Jun 2020 10:33:41 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9D2022053B for ; Thu, 25 Jun 2020 10:33:41 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="ckSbRH6Y" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2404035AbgFYKdk (ORCPT ); Thu, 25 Jun 2020 06:33:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38546 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2403816AbgFYKdj (ORCPT ); Thu, 25 Jun 2020 06:33:39 -0400 Received: from mail-wm1-x344.google.com (mail-wm1-x344.google.com [IPv6:2a00:1450:4864:20::344]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AFB50C061573 for ; Thu, 25 Jun 2020 03:33:38 -0700 (PDT) Received: by mail-wm1-x344.google.com with SMTP id 22so5044300wmg.1 for ; Thu, 25 Jun 2020 03:33:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:content-transfer-encoding:in-reply-to; bh=cwS7iBZ35KlWA6jBEXe+RY7hU/oltm4mf+ZLVTmBHbg=; b=ckSbRH6Y9xOKw8TwFf5S6Fhk1vOPMMffz1PvAsd5fQkuEUwGeqv8ZMfu7b4VseJXq+ Q+Zwl6jtJPG6b8nC0vUNjXsuJBAHkcblkb0pQgjxdlrWuvAO3vVH5EOdN8ykR1fFNkO2 0Y3+9hQyIHdmKpwtONksi/eq/d8zwBaAwnMZiCl2cMapDRa21bVFWnrvJmrLcOy/lGA5 r1jIAR/pLarr4nRMPCFRPDiBFXE3KVAPa2+iPKV0c4lCbi24fnFNTvU8a5C/BFnrqmFF NBvqmgslp9dIo5O2WX8S0qZbHFB5FnOKAffE3NigkrXiKcASZlQGDfgOFNp/1b16IVxq irbw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:content-transfer-encoding :in-reply-to; bh=cwS7iBZ35KlWA6jBEXe+RY7hU/oltm4mf+ZLVTmBHbg=; b=rNUUvuSJ/SOcYxDx1h18mfFXnCWjk6M11WZBMGz5dT+hB+hcaKqzkDCMqg6rkFRiw8 xX4cxRh6rLoYkWWNkyR0odVwOPf81+ZMcWm863NEToxvXTFlHOUmgn9ntUduxgSZn26u cLEHO8CpDOWupH65BFMxNXzrCcSzZlcDBaaj+XMI1EnPBf4dMLcG2zbuoMO/q80cQLdk cPKEVS8EY7wG5eLm467PDhAxSkb3Px2+K3b/alLcJXBuZvMLdTln6Cgo1xiKqfng5HJ0 rAmvmC/U5i6iXNSuht6IIfT74igkPWvAFfql0FBrpZ1ktRFrGT/pvwqvChf0wZF4mDnK r98A== X-Gm-Message-State: AOAM530vxvDO1NenMb2ZnAeNsXcmAZIAhb8Qp05pZaJx81VtmmRU4S8h dHkplIir+J71Hmb5CV+t0Q82Gg== X-Google-Smtp-Source: ABdhPJxRQCCMvNxIjXjxszNKanKw0pTi4YzKhm6dZatNk1oJ81au17V7nolB179hYdVcODuntoi7tQ== X-Received: by 2002:a7b:ce97:: with SMTP id q23mr2641581wmj.89.1593081217260; Thu, 25 Jun 2020 03:33:37 -0700 (PDT) Received: from dell ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id t4sm5852497wmf.4.2020.06.25.03.33.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Jun 2020 03:33:36 -0700 (PDT) Date: Thu, 25 Jun 2020 11:33:34 +0100 From: Lee Jones To: Daniel Thompson Cc: jingoohan1@gmail.com, dri-devel@lists.freedesktop.org, linux-fbdev@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, stable@vger.kernel.org, Bartlomiej Zolnierkiewicz , Software Engineering Subject: Re: [PATCH 3/8] backlight: ili922x: Add missing kerneldoc descriptions for CHECK_FREQ_REG() args Message-ID: <20200625103334.GO954398@dell> References: <20200624145721.2590327-1-lee.jones@linaro.org> <20200624145721.2590327-4-lee.jones@linaro.org> <20200625094051.u4hanl3rycczlwiy@holly.lan> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <20200625094051.u4hanl3rycczlwiy@holly.lan> Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Thu, 25 Jun 2020, Daniel Thompson wrote: > On Wed, Jun 24, 2020 at 03:57:16PM +0100, Lee Jones wrote: > > Kerneldoc syntax is used, but not complete. Descriptions required. > > > > Prevents warnings like: > > > > drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 's' not described in 'CHECK_FREQ_REG' > > drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 'x' not described in 'CHECK_FREQ_REG' > > > > Cc: > > Cc: Bartlomiej Zolnierkiewicz > > Cc: Software Engineering > > Signed-off-by: Lee Jones > > --- > > drivers/video/backlight/ili922x.c | 2 ++ > > 1 file changed, 2 insertions(+) > > > > diff --git a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c > > index 9c5aa3fbb2842..8cb4b9d3c3bba 100644 > > --- a/drivers/video/backlight/ili922x.c > > +++ b/drivers/video/backlight/ili922x.c > > @@ -107,6 +107,8 @@ > > * lower frequency when the registers are read/written. > > * The macro sets the frequency in the spi_transfer structure if > > * the frequency exceeds the maximum value. > > + * @s: pointer to controller side proxy for an SPI slave device > > What's wrong with "a pointer to an SPI device"? > > I am aware, having looked it up to find out what the above actually > means, that this is how struct spi_device is described in its own kernel > doc but quoting at that level of detail of both overkill and confusing. I figured that using the official description would be better than making something up. However if you think it's better to KISS, then I can change it. -- Lee Jones [李琼斯] Senior Technical Lead - Developer Services Linaro.org │ Open source software for Arm SoCs Follow Linaro: Facebook | Twitter | Blog