From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thierry Reding Subject: Re: [PATCH 07/12] drm/irq: kerneldoc polish Date: Thu, 15 May 2014 09:21:22 +0200 Message-ID: <20140515072121.GB5952@ulmo> References: <1400093477-3217-1-git-send-email-daniel.vetter@ffwll.ch> <1400093477-3217-8-git-send-email-daniel.vetter@ffwll.ch> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============0137181269==" Return-path: In-Reply-To: <1400093477-3217-8-git-send-email-daniel.vetter@ffwll.ch> 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: Intel Graphics Development , DRI Development List-Id: intel-gfx@lists.freedesktop.org --===============0137181269== Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="VrqPEDrXMn8OVzN4" Content-Disposition: inline --VrqPEDrXMn8OVzN4 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline On Wed, May 14, 2014 at 08:51:09PM +0200, Daniel Vetter wrote: [...] > diff --git a/drivers/gpu/drm/drm_irq.c b/drivers/gpu/drm/drm_irq.c [...] > index dd786d84daab..5ff986bd4de4 100644 > --- a/drivers/gpu/drm/drm_irq.c > +++ b/drivers/gpu/drm/drm_irq.c > @@ -1,6 +1,5 @@ > -/** > - * \file drm_irq.c > - * IRQ support > +/* > + * drm_irq.c IRQ and vblank support Perhaps drop the filename here? It's completely redundant. > +/** > + * drm_vblank_cleanup - cleanup vblank support > + * @dev: drm device Technically DRM is an abbreviation and therefore should be all uppercase. > +/** > + * drm_vblank_init - initialize vblank support > + * @dev: drm_device s/drm_device/DRM device/? > + * @num_crtcs: number of crtcs supported by @dev CRTC is also an abbreviation, so I think this should be s/crtcs/CRTCs/. > + * Returns: According to Documentation/kernel-doc-nano-HOWTO.txt this section should be called "Return:". I'm not sure it matters all that much, since it seems to be only used as the title of a new section, but I think it makes sense to follow the recommendation of the documentation. > /** > - * Install IRQ handler. > - * > - * \param dev DRM device. > + * drm_irq_install - install IRQ handler > + * @dev: drm device > + * @irq: irq number to install the handler for I know you're probably going to hate me for this, but: IRQ is an abbreviation. =) > -/** > +/* > * IRQ control ioctl. > * > * \param inode device inode. Perhaps it would still make sense to change the comment style to kernel-doc, even if it isn't exported. > /** > - * drm_calc_vbltimestamp_from_scanoutpos - helper routine for kms > - * drivers. Implements calculation of exact vblank timestamps from > - * given drm_display_mode timings and current video scanout position > - * of a crtc. This can be called from within get_vblank_timestamp() > - * implementation of a kms driver to implement the actual timestamping. > + * drm_calc_vbltimestamp_from_scanoutpos - precise vblank timestamp helper > + * @dev: drm device > + * @crtc: Which crtc's vblank timestamp to retrieve > + * @max_error: Desired maximum allowable error in timestamps (nanosecs) > + * On return contains true maximum error of timestamp > + * @vblank_time: Pointer to struct timeval which should receive the timestamp > + * @flags: Flags to pass to driver: > + * 0 = Default, > + * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl irq handler > + * @refcrtc: drm_crtc* of crtc which defines scanout timing I think s/drm_crtc * of// would be okay here. > /** > * drm_vblank_off - disable vblank events on a CRTC > - * @dev: DRM device > + * @dev: drm device > * @crtc: CRTC in question > + * > + * Drivers can use this function to shut down the vblank interrupt handling when > + * disabling a crtc. This function ensures that the latest vblank frame count is > + * stored so that drm_vblank_on can restore it again. drm_vblank_on() to have it correctly highlighted? Thierry --VrqPEDrXMn8OVzN4 Content-Type: application/pgp-signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.22 (GNU/Linux) iQIcBAEBAgAGBQJTdGrxAAoJEN0jrNd/PrOhAOoP/1ZbUjkXjoiKqlGd2MTq8vMx EqrJvDLAvrYuITbam72m4tY+9rZRoafxHmwBK/UiC4qXDVY3V0KrGry3iEMrjiQf h3OUYW0/YyhklD1geEr/E7anPPn/Jw6NRp2pVTi9Z33LT3/q1BHTjUsMfApsOknb K19BgV0X2SqLqQKw2aGSwrrIHT1QiW9jm8kRpRRxZ70cA8USZPrtackuRWLKQj+9 zl8aHC+npXfmgJWSS0iNwsmWACVvTp8i4wRIp6EnSy+V9R/W/32W0G2MD/UvxXBv s3907Rv0p+LZCRtNw+6IeymLXhTK4gyy/oZDWbqFZKQEmuBMAd5RAflM6HSDK2zZ hC/B4D8EdTtQr/4+yoDNunphjqa01wZ9PzlgB0omBxRh6iTugXYJgkmBEj06g1AM zOnDf3wH7qiv+CkN8buEcAsdgU3TWvwQNoI09VbSHjlrPbCHbGaTGM4dbkHiTTjU QvtqrKykl5KItqVJOD/zfab+Ak/7hho+YFQvJuqtl2gN/FaT04SYqpS+bWhLo6dO 5fZGCXOHhy0Qy6lvZxsp/bQWVi0zIrEmsAX8rF0NBJm4dCbQ6jlpu7hgKlFk5x78 QwtMy9a8Ey4J22cHH7sZemY6vegHitxCyqPHKKTxte/8yRYKb6nTx0dqRQ5Zxdrk X35mJ6cnKmzyA+Q/wMFy =+rhG -----END PGP SIGNATURE----- --VrqPEDrXMn8OVzN4-- --===============0137181269== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ dri-devel mailing list dri-devel@lists.freedesktop.org http://lists.freedesktop.org/mailman/listinfo/dri-devel --===============0137181269==--