From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id CDAAF39AD5; Tue, 9 Jan 2024 15:29:00 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="T6f9FSxo" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: Content-Type:In-Reply-To:From:References:Cc:To:Subject:MIME-Version:Date: Message-ID:Sender:Reply-To:Content-ID:Content-Description; bh=uPIqJIHp3X/XsFHDVb+kMrsUva3gpzeRWc9fBtinlSA=; b=T6f9FSxoDKiyE9GUehRHlWFYnT XFlxtEYStAy3FlZ/ssOVMNNMAHokubh8DvBH3bqU/CaV+btaE1bcE56fwnPJ0FTvv7H22KfCv7jr3 pIRuj+mHBZkTFGzfohjsjmjTCD5GP+LIrvF9j3BxK5og+/jct59zySUhWJGDpdmIuJi0gUfSviXE0 NdXdGEVqAgZjQHQBYZa1lFY4EQoRG/uH7Nb1fBM7j2cDiNYDBzZkTdXxaUjSR4VkmGJFZRg164VbW 1DwGFC6WtJ1Z0iyHOkcen8U/nOsxkKXas58FYpKv/klQnR2TZpVeRmR9kU9yMdeN1flxfRjPX9lps cnU+lS1g==; Received: from [50.53.46.231] (helo=[192.168.254.15]) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rNE2F-008fw4-1l; Tue, 09 Jan 2024 15:28:59 +0000 Message-ID: Date: Tue, 9 Jan 2024 07:28:59 -0800 Precedence: bulk X-Mailing-List: linux-doc@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v2] drm/vram-helper: fix kernel-doc warnings Content-Language: en-US To: Daniel Vetter Cc: Thomas Zimmermann , linux-kernel@vger.kernel.org, David Airlie , dri-devel@lists.freedesktop.org, Maarten Lankhorst , Maxime Ripard , linux-doc@vger.kernel.org, Jonathan Corbet References: <20240106032957.1195-1-rdunlap@infradead.org> <944ca2e6-23d9-44a2-a58c-4380e9ee575f@suse.de> <10b6ec8a-8b58-43a0-a3f8-c6d354b71ee4@infradead.org> From: Randy Dunlap In-Reply-To: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit On 1/9/24 07:25, Daniel Vetter wrote: > On Tue, 9 Jan 2024 at 16:23, Randy Dunlap wrote: >> >> >> >> On 1/9/24 05:42, Daniel Vetter wrote: >>> On Tue, 9 Jan 2024 at 13:59, Daniel Vetter wrote: >>>> >>>> On Mon, Jan 08, 2024 at 01:10:12PM -0800, Randy Dunlap wrote: >>>>> Hi Thomas, >>>>> >>>>> On 1/8/24 00:57, Thomas Zimmermann wrote: >>>>>> Hi, >>>>>> >>>>>> thanks for the fix. >>>>>> >>>>>> Am 06.01.24 um 04:29 schrieb Randy Dunlap: >>>>>>> Remove the @funcs entry from struct drm_vram_mm to quieten the kernel-doc >>>>>>> warning. >>>>>>> >>>>>>> Use the "define" kernel-doc keyword and an '\' line continuation >>>>>>> to fix another kernel-doc warning. >>>>>>> >>>>>>> drm_gem_vram_helper.h:129: warning: missing initial short description on line: >>>>>>> * DRM_GEM_VRAM_PLANE_HELPER_FUNCS - >>>>>>> drm_gem_vram_helper.h:185: warning: Excess struct member 'funcs' description in 'drm_vram_mm' >>>>>>> >>>>>>> Signed-off-by: Randy Dunlap >>>>>>> Cc: David Airlie >>>>>>> Cc: Daniel Vetter >>>>>>> Cc: dri-devel@lists.freedesktop.org >>>>>>> Cc: Maarten Lankhorst >>>>>>> Cc: Maxime Ripard >>>>>>> Cc: Thomas Zimmermann >>>>>>> --- >>>>>>> v2: Add commit description >>>>>>> >>>>>>> base-commit: 610a9b8f49fbcf1100716370d3b5f6f884a2835a >>>>>>> >>>>>>> include/drm/drm_gem_vram_helper.h | 3 +-- >>>>>>> 1 file changed, 1 insertion(+), 2 deletions(-) >>>>>>> >>>>>>> diff -- a/include/drm/drm_gem_vram_helper.h b/include/drm/drm_gem_vram_helper.h >>>>>>> --- a/include/drm/drm_gem_vram_helper.h >>>>>>> +++ b/include/drm/drm_gem_vram_helper.h >>>>>>> @@ -126,7 +126,7 @@ drm_gem_vram_plane_helper_cleanup_fb(str >>>>>>> struct drm_plane_state *old_state); >>>>>>> /** >>>>>>> - * DRM_GEM_VRAM_PLANE_HELPER_FUNCS - >>>>>>> + * define DRM_GEM_VRAM_PLANE_HELPER_FUNCS - \ >>>>>> >>>>>> Did something change wrt. doc syntax? I think this used to work without warnings. About this 'define': we don't use is in another docs. Can we leave it out here or is this the new syntax? >>>>>> >>>>> >>>>> There are no doc syntax changes that I know of. This is not >>>>> new syntax. It has been around since 2014: >>>>> cbb4d3e6510b ("scripts/kernel-doc: handle object-like macros") >>>> >>>> I had no idea this exists, thanks a lot for this TIL :-) >>>> >>>> I guess the issue here is that this exists, yay, but it's not documented >>>> with the other here: >>>> >>>> https://dri.freedesktop.org/docs/drm/doc-guide/kernel-doc.html#structure-union-and-enumeration-documentation >>>> >>>> I guess a patch to kernel-doc.rst would be great. Adding some kernel-doc >>>> folks. >>> >>> Ok I went ahead and typed that patch (just we don't waste effort), >>> just waiting for the sphinx build to finish to make sure it looks nice >>> before I send out the patch. >>> -Sima >> >> I sent one a few days ago: >> >> https://lore.kernel.org/lkml/20240107012400.32587-1-rdunlap@infradead.org/ > > Could you please also add documentation for function-like macros, > since that's also missing? With that acked-by: me. > > Cheers! This is already present: Function documentation ---------------------- The general format of a function and function-like macro kernel-doc comment is:: /** * function_name() - Brief description of function. * @arg1: Describe the first argument. * @arg2: Describe the second argument. * One can provide multiple line descriptions * for arguments. but the way that you did it makes sense also. -- #Randy