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 08:39:12 +0200 Message-ID: <3b574a1c-8dee-962f-e2ad-4959e75321d7@suse.de> References: <20190604111330.25324-1-tzimmermann@suse.de> <20190605090308.efdkhxqnaydorubm@sirius.home.kraxel.org> <20190605155847.gabpvcoc6zf3twfv@sirius.home.kraxel.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============1276025180==" Return-path: Received: from mx1.suse.de (mx2.suse.de [195.135.220.15]) by gabe.freedesktop.org (Postfix) with ESMTPS id 1E00189319 for ; Thu, 6 Jun 2019 06:39:18 +0000 (UTC) In-Reply-To: <20190605155847.gabpvcoc6zf3twfv@sirius.home.kraxel.org> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" To: Gerd Hoffmann Cc: maxime.ripard@bootlin.com, sean@poorly.run, dri-devel@lists.freedesktop.org List-Id: dri-devel@lists.freedesktop.org This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --===============1276025180== Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="dJfrPCua9c8dLWYmoEdcvVoqOcIlv2vp4" This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --dJfrPCua9c8dLWYmoEdcvVoqOcIlv2vp4 Content-Type: multipart/mixed; boundary="YQhMjOjdsKBvbB2KM33UKFJxvC6KRFQFj"; protected-headers="v1" From: Thomas Zimmermann To: Gerd Hoffmann Cc: maxime.ripard@bootlin.com, sean@poorly.run, dri-devel@lists.freedesktop.org Message-ID: <3b574a1c-8dee-962f-e2ad-4959e75321d7@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> In-Reply-To: <20190605155847.gabpvcoc6zf3twfv@sirius.home.kraxel.org> --YQhMjOjdsKBvbB2KM33UKFJxvC6KRFQFj Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: quoted-printable 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 function = 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_mm_f= uncs'. >=20 > Ah. Missed that detail. >=20 >> Documenting global constants is not described in the kernel guide and = I >> could not find a source-code example either. Function and struct style= >> with '-' didn't work; member-field style with '@' neither. The only wa= y >> 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. >=20 > Ok, patch is fine then. >=20 > Acked-by: Gerd Hoffmann Thanks. > (can you commit & push yourself meanwhile?) Not yet. The respective bug report is still open. Best regards Thomas > cheers, > Gerd >=20 > _______________________________________________ > dri-devel mailing list > dri-devel@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/dri-devel >=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) --YQhMjOjdsKBvbB2KM33UKFJxvC6KRFQFj-- --dJfrPCua9c8dLWYmoEdcvVoqOcIlv2vp4 Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- iQEzBAEBCAAdFiEEchf7rIzpz2NEoWjlaA3BHVMLeiMFAlz4tRMACgkQaA3BHVML eiNtpAf7BL/+LphncTkXfJ3Z92Trmv0ZycZFfVb/65VctruGBQs1HOiVc9f/ZnPq 8CFAnJjZ7CUD2xTmJRYRRu7Fn4UMAZEb6/IkqUmZrDGrk/YikPyPD0m02M0bKvAo TFFuDy1R1nc23W8Th/GehMsaor4rvxmUo5rR7JUHNPU5l2CH65TQy6+SPH4Rnz2q iOIuqoLnstEPc7owDiJB2nv/7zXPYNwXnpRQRHqWCMqWjISfSFF4oIGxjIV78zJR Y0DAoBIh04cH81zoJuSlXyo9rK8RYmwWTx0gQi64h3ugaK5zRKKZU7FSizmZt5l7 TSSSviqwDYVhvQfAdiplcr3PX7jjqA== =+iu0 -----END PGP SIGNATURE----- --dJfrPCua9c8dLWYmoEdcvVoqOcIlv2vp4-- --===============1276025180== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: inline X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18KZHJpLWRldmVs IG1haWxpbmcgbGlzdApkcmktZGV2ZWxAbGlzdHMuZnJlZWRlc2t0b3Aub3JnCmh0dHBzOi8vbGlz dHMuZnJlZWRlc2t0b3Aub3JnL21haWxtYW4vbGlzdGluZm8vZHJpLWRldmVs --===============1276025180==--