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: Wed, 5 Jun 2019 11:59:04 +0200 Message-ID: References: <20190604111330.25324-1-tzimmermann@suse.de> <20190605090308.efdkhxqnaydorubm@sirius.home.kraxel.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============0891144293==" Return-path: Received: from mx1.suse.de (mx2.suse.de [195.135.220.15]) by gabe.freedesktop.org (Postfix) with ESMTPS id 4F14B897BC for ; Wed, 5 Jun 2019 09:59:10 +0000 (UTC) In-Reply-To: <20190605090308.efdkhxqnaydorubm@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) --===============0891144293== Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="cwG4XZyrs1BKbgF15DdlYCFGGE1vy1byA" This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --cwG4XZyrs1BKbgF15DdlYCFGGE1vy1byA Content-Type: multipart/mixed; boundary="vI46v976G8cbVSg3rrlmfwA1PH1TRdsax"; protected-headers="v1" From: Thomas Zimmermann To: Gerd Hoffmann Cc: daniel@ffwll.ch, maarten.lankhorst@linux.intel.com, maxime.ripard@bootlin.com, sean@poorly.run, dri-devel@lists.freedesktop.org Message-ID: 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> In-Reply-To: <20190605090308.efdkhxqnaydorubm@sirius.home.kraxel.org> --vI46v976G8cbVSg3rrlmfwA1PH1TRdsax Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: quoted-printable 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 an= d >> there appears to be no way of inline-documenting constants. >=20 >> -/** >> +/* >> * drm_gem_vram_mm_funcs - Functions for &struct drm_vram_mm >=20 > "struct drm_gem_vram_mm_funcs" ? >=20 > (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_func= s'. 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 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. Best regards Thomas > cheers, > Gerd >=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) --vI46v976G8cbVSg3rrlmfwA1PH1TRdsax-- --cwG4XZyrs1BKbgF15DdlYCFGGE1vy1byA Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- iQEzBAEBCAAdFiEEchf7rIzpz2NEoWjlaA3BHVMLeiMFAlz3kmgACgkQaA3BHVML eiP4fgf/fqwFH0VsJrnvqrV3lbYrUcOl3mg3flNMg9qr+A8IuyhxZrnLpuQ4usjp zi73eYhrX8J7yGPxZe04RIdyKXhoawHgDkkIUA46FMV4AvnlvwCshR/dNIB+XasQ J0qhUk/UTMCz8bI7xsIE6yS9cHlKcpHVmIGJUd94KpjKRd4XQZRphwPNeJpUeKKU HRuD8KiO7QQZe1CmowhFJdEiEynY6n+g8MIG7w0efWZHP4Qa0qt1H08L+JiChxBT iOfSGrHczV2Obut/Ku5QAg42QZcMSYF5CHBnADx2KiZyFzRHNqm3tTQq6eNU+kNG fk+mv5pMeKkiMxbbrpGhs7GVRMOA7Q== =Eb31 -----END PGP SIGNATURE----- --cwG4XZyrs1BKbgF15DdlYCFGGE1vy1byA-- --===============0891144293== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: inline X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18KZHJpLWRldmVs IG1haWxpbmcgbGlzdApkcmktZGV2ZWxAbGlzdHMuZnJlZWRlc2t0b3Aub3JnCmh0dHBzOi8vbGlz dHMuZnJlZWRlc2t0b3Aub3JnL21haWxtYW4vbGlzdGluZm8vZHJpLWRldmVs --===============0891144293==--