Re: [PATCH 01/20] drm/doc: Fix more kerneldoc/sphinx warnings

From: "Ville Syrjälä" <ville.syrjala@linux.intel.com>
To: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>,
	DRI Development <dri-devel@lists.freedesktop.org>,
	Markus Heiser <markus.heiser@darmarit.de>,
	linux-doc@vger.kernel.org,
	Intel Graphics Development <intel-gfx@lists.freedesktop.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Daniel Vetter <daniel.vetter@intel.com>
Subject: Re: [PATCH 01/20] drm/doc: Fix more kerneldoc/sphinx warnings
Date: Thu, 11 Aug 2016 11:23:23 +0300	[thread overview]
Message-ID: <20160811082323.GJ4329@intel.com> (raw)
In-Reply-To: <871t1vwwku.fsf@intel.com>

On Thu, Aug 11, 2016 at 11:15:13AM +0300, Jani Nikula wrote:
> On Tue, 09 Aug 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> > These are the leftovers I could only track down using keep_warnings =
> > True. For some of them we might want to update our style guide on how
> > to reference structures and constants, not sure ...
> >
> > Cc: Markus Heiser <markus.heiser@darmarit.de>
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Cc: linux-doc@vger.kernel.org
> > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> > ---
> >  drivers/gpu/drm/drm_crtc.c              |  4 ++--
> >  drivers/gpu/drm/drm_fb_helper.c         |  2 +-
> >  drivers/gpu/drm/drm_irq.c               |  8 +++----
> >  drivers/gpu/drm/drm_simple_kms_helper.c |  2 +-
> >  drivers/gpu/drm/i915/i915_vgpu.c        | 42 ++++++++++++++++-----------------
> >  drivers/gpu/drm/i915/intel_audio.c      |  6 ++---
> >  drivers/gpu/drm/i915/intel_guc_fwif.h   |  5 ++--
> >  include/drm/drm_crtc.h                  |  8 +++----
> >  include/drm/drm_gem.h                   |  4 ++--
> >  9 files changed, 41 insertions(+), 40 deletions(-)
> >
> > diff --git a/drivers/gpu/drm/drm_crtc.c b/drivers/gpu/drm/drm_crtc.c
> > index 3d03eb1e3b63..ad38a8a31898 100644
> > --- a/drivers/gpu/drm/drm_crtc.c
> > +++ b/drivers/gpu/drm/drm_crtc.c
> > @@ -1272,7 +1272,7 @@ static unsigned int drm_num_planes(struct drm_device *dev)
> >   * @plane: plane object to init
> >   * @possible_crtcs: bitmask of possible CRTCs
> >   * @funcs: callbacks for the new plane
> > - * @formats: array of supported formats (%DRM_FORMAT_*)
> > + * @formats: array of supported formats (DRM_FORMAT\_\*)
> 
> Future idea: If we turned DRM_FORMAT_* into an enum instead of a
> plethora of macros, we could reference the enum here. Not to mention the
> code being self-documenting too.

DRM_FORMAT_* is uapi, so can't change it.

-- 
Ville Syrjälä
Intel OTC