From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thierry Reding Subject: Re: [PATCH 07/28] drm: Update drm_plane_funcs kerneldoc Date: Mon, 7 Dec 2015 13:43:49 +0100 Message-ID: <20151207124349.GA13177@ulmo> References: <1449218769-16577-1-git-send-email-daniel.vetter@ffwll.ch> <1449218769-16577-8-git-send-email-daniel.vetter@ffwll.ch> <20151207114638.GJ13177@ulmo> <20151207123416.GF10243@phenom.ffwll.local> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============0421099787==" Return-path: In-Reply-To: <20151207123416.GF10243@phenom.ffwll.local> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" To: Daniel Vetter Cc: Daniel Vetter , Intel Graphics Development , DRI Development , Daniel Vetter List-Id: intel-gfx@lists.freedesktop.org --===============0421099787== Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="5mjPmdht4ZehXHR2" Content-Disposition: inline --5mjPmdht4ZehXHR2 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Mon, Dec 07, 2015 at 01:34:16PM +0100, Daniel Vetter wrote: > On Mon, Dec 07, 2015 at 12:46:38PM +0100, Thierry Reding wrote: > > On Fri, Dec 04, 2015 at 09:45:48AM +0100, Daniel Vetter wrote: > > > diff --git a/include/drm/drm_crtc.h b/include/drm/drm_crtc.h > > [...] > > > + /** > > > + * @destroy: > > > + * > > > + * Clean up CRTC resources. This is only called at driver unload ti= me > >=20 > > Perhaps drop "only" because there are more than a single potential > > usage? >=20 > It's for driver unload only since you can't hotplug planes. The only > hotpluggable thing in drm atm are connectors, and I've added these blurbs > to highlight that. The complete hunk is this: + * Clean up CRTC resources. This is only called at driver unload ti= me + * through drm_mode_config_cleanup(), but can also be called at run= time + * when a CRTC is being hot-unplugged. If you say CRTCs aren't hotpluggable then the above is very confusing. So either it is only called at driver unload time (which is what you're saying, since CRTCs aren't hotpluggable) or it can be called in other circumstances, in which case "only" is wrong. So I think either drop the last subsentence to reflect the current capabilities of the subsystem, or make it something like the following to clarify: The DRM subsystem doesn't currently support hotplugging CRTCs, but eventually that feature might be added, at which point this callback will be called when a CRTC in hot-unplugged. But since nobody knows when this will happen it's somewhat premature, in my opinion, to have such documentation. kerneldoc should document facts, not the roadmap. Thierry --5mjPmdht4ZehXHR2 Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 iQIcBAABCAAGBQJWZX8FAAoJEN0jrNd/PrOhzYIP/3ETsH4bJfkHV7IxVRVHRmNk mdFgPcD6JR/l44rvRlUyEIcaCBJSeZFWQg/hgMvaKDTewoDNE0dZ+QygQaL+ONOo e65eHYyP/ua+yItFhQWFWjH9c/LN7+vIUdi7X5A/PDXBWKlnCuXsdP1ZfcSpmcih Lwm9ME5onINV3g6qZNZxNB8vdzDzu7SYrSknYMhAEIEMuntCnX0peMa4+oTAXHXt LNrwUus8qC9tMfqC7o0U5RKnlddSOFVnmqCh4Go8VOVEmh3oqaDhTFJJFSm3Fwj6 TjNsD9uVO73UR8eRGESA/+IgN8cGcUOk3aqpzbmkrpOqHswN8bX1v+QKAG6MerUi OLrwz/CjWlwlZTVZwXMTkjuKSDeLXydFq5oSiVsu4nBB2R31C9mDJ3mw5wHMvOfO IZHdyZCtYf44v9FqZSxnU1r2zVmXIyBmu5AgHGHljKHI8YlVNT4V6N4lIqfk9tT1 HrI0K41nC7YvyrLfi+mFbeRGxMG7/09dywkZ3ct2irqe9A9759Uvz37vhEABeS7l uH8DyuTANxcHBexfPyCYB88lKFINK4JohDtPa5wvRl6kTQx5OjHbknd9wXcZ8OC6 pp9dbZhqbV8su+ydY/xn2DMfoE/dSmCMDOsZP3mhF5ScabEIKip3gVHi0fxEGpQu 8AOmaeMsfJvE0TTOsl3H =cy/E -----END PGP SIGNATURE----- --5mjPmdht4ZehXHR2-- --===============0421099787== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: inline X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18KZHJpLWRldmVs IG1haWxpbmcgbGlzdApkcmktZGV2ZWxAbGlzdHMuZnJlZWRlc2t0b3Aub3JnCmh0dHA6Ly9saXN0 cy5mcmVlZGVza3RvcC5vcmcvbWFpbG1hbi9saXN0aW5mby9kcmktZGV2ZWwK --===============0421099787==--