From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Zimmermann Subject: Re: [PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation Date: Thu, 6 Jun 2019 10:03:23 +0200 Message-ID: <26d3e769-d995-1683-2382-e28f97239286@suse.de> References: <20190604111330.25324-1-tzimmermann@suse.de> <20190605090308.efdkhxqnaydorubm@sirius.home.kraxel.org> <20190605155847.gabpvcoc6zf3twfv@sirius.home.kraxel.org> <3b574a1c-8dee-962f-e2ad-4959e75321d7@suse.de> <20190606074515.wlyzzlqdv7r2urum@sirius.home.kraxel.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============0575228061==" Return-path: Received: from mx1.suse.de (mx2.suse.de [195.135.220.15]) by gabe.freedesktop.org (Postfix) with ESMTPS id 489438932A for ; Thu, 6 Jun 2019 08:03:29 +0000 (UTC) In-Reply-To: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" To: Daniel Vetter , Gerd Hoffmann Cc: Maxime Ripard , Sean Paul , dri-devel List-Id: dri-devel@lists.freedesktop.org This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --===============0575228061== Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="0FKGBk8Dsn7R4rKGVfTOCMPY4DTpuFrkf" This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --0FKGBk8Dsn7R4rKGVfTOCMPY4DTpuFrkf Content-Type: multipart/mixed; boundary="E6SGxB8hdbnobH4WMBiEpsnTQBrm8RSs7"; protected-headers="v1" From: Thomas Zimmermann To: Daniel Vetter , Gerd Hoffmann Cc: Maxime Ripard , Sean Paul , dri-devel Message-ID: <26d3e769-d995-1683-2382-e28f97239286@suse.de> Subject: Re: [PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation References: <20190604111330.25324-1-tzimmermann@suse.de> <20190605090308.efdkhxqnaydorubm@sirius.home.kraxel.org> <20190605155847.gabpvcoc6zf3twfv@sirius.home.kraxel.org> <3b574a1c-8dee-962f-e2ad-4959e75321d7@suse.de> <20190606074515.wlyzzlqdv7r2urum@sirius.home.kraxel.org> In-Reply-To: --E6SGxB8hdbnobH4WMBiEpsnTQBrm8RSs7 Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: quoted-printable Hi Am 06.06.19 um 09:49 schrieb Daniel Vetter: > On Thu, Jun 6, 2019 at 9:45 AM Gerd Hoffmann wrote:= >> >> On Thu, Jun 06, 2019 at 08:39:12AM +0200, Thomas Zimmermann wrote: >>> Hi >>> >>> Am 05.06.19 um 17:58 schrieb Gerd Hoffmann: >>>> On Wed, Jun 05, 2019 at 11:59:04AM +0200, Thomas Zimmermann wrote: >>>>> Hi >>>>> >>>>> Am 05.06.19 um 11:03 schrieb Gerd Hoffmann: >>>>>> On Tue, Jun 04, 2019 at 01:13:30PM +0200, Thomas Zimmermann wrote:= >>>>>>> The documentation tools interpret drm_gem_vram_mm_funcs as functi= on and >>>>>>> there appears to be no way of inline-documenting constants. >>>>>> >>>>>>> -/** >>>>>>> +/* >>>>>>> * drm_gem_vram_mm_funcs - Functions for &struct drm_vram_mm >>>>>> >>>>>> "struct drm_gem_vram_mm_funcs" ? >>>>>> >>>>>> (see include/drm/drm_gem.h where struct drm_gem_object_funcs is >>>>>> documented that way). >>>>> >>>>> The documented source line is >>>>> >>>>> const struct drm_vram_mm_funcs drm_gem_vram_mm_funcs =3D { >>>>> >>>>> and I tried to document the purpose of the constant 'drm_gem_vram_m= m_funcs'. >>>> >>>> Ah. Missed that detail. >>>> >>>>> Documenting global constants is not described in the kernel guide a= nd I >>>>> could not find a source-code example either. Function and struct st= yle >>>>> with '-' didn't work; member-field style with '@' neither. The only= way >>>>> seems to be adding it to an .rst file in Documentation. But then it= 's >>>>> not part of the API documentation, but somewhere in the text. >>>> >>>> Ok, patch is fine then. >>>> >>>> Acked-by: Gerd Hoffmann >>> >>> Thanks. >>> >>>> (can you commit & push yourself meanwhile?) >>> >>> Not yet. The respective bug report is still open. >> >> Ok, I'll push it then. >=20 > You should have commit rights for drm-misc, I just checked. At least > there's a tzimmermann account in the drm-misc group. Thanks for the update. Gerd, if you haven't pushed it yet I'm going to add this patch to the tre= e. Best regards Thomas > https://drm.pages.freedesktop.org/maintainer-tools/getting-started.html= >=20 > ... to get you going. If things don't work pls ping on #dri-devel on fr= eenode. > -Daniel >=20 --=20 Thomas Zimmermann Graphics Driver Developer SUSE Linux GmbH, Maxfeldstrasse 5, 90409 Nuernberg, Germany GF: Felix Imend=C3=B6rffer, Mary Higgins, Sri Rasiah HRB 21284 (AG N=C3=BCrnberg) --E6SGxB8hdbnobH4WMBiEpsnTQBrm8RSs7-- --0FKGBk8Dsn7R4rKGVfTOCMPY4DTpuFrkf Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- iQEzBAEBCAAdFiEEchf7rIzpz2NEoWjlaA3BHVMLeiMFAlz4yMsACgkQaA3BHVML eiMAXAf/S6oFLlC3M3ccbJRyE+s3+kczMJLuZzRtLPbEkTk+6j8g2TXmc/Fdh1P5 jcXhgbUeF1K1LmGpbCO6Eb+C4lrU1koYA99jxhI0mIX+mtj7G6mROE7XbN51ZZ0A 2Db0M3gmDUjjeAUbU0GFxmRsewhNibE/tufbV83yaZotVkYPugCsfm08R32LfphH VxoqQ86ryzYMPWjGpr+JyQMq/yHAAKW7RGEbnSIYIqxycQA9IFTCc/yemklW8tLo xVFfAcUeyqfdoM0cxJf7Bg34ClOVadSptrvGDaA42VkR04u6Ohif9kI4BGNegJX5 FGu7BwiDf+PfRjqA26HVtwJkdHiO5w== =m9Hd -----END PGP SIGNATURE----- --0FKGBk8Dsn7R4rKGVfTOCMPY4DTpuFrkf-- --===============0575228061== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: inline X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18KZHJpLWRldmVs IG1haWxpbmcgbGlzdApkcmktZGV2ZWxAbGlzdHMuZnJlZWRlc2t0b3Aub3JnCmh0dHBzOi8vbGlz dHMuZnJlZWRlc2t0b3Aub3JnL21haWxtYW4vbGlzdGluZm8vZHJpLWRldmVs --===============0575228061==--