[Intel-gfx] [PATCH 03/15] drm/kms-core: Use recommened kerneldoc for struct member refs
I just learned that &struct_name.member_name works and looks pretty even. It doesn't (yet) link to the member directly though, which would be really good for big structures or vfunc tables (where the per-member kerneldoc tends to be long). Also some minor drive-by polish where it makes sense, I read a lot of docs ... Cc: Jani Nikula Cc: Chris Wilson Signed-off-by: Daniel Vetter --- drivers/gpu/drm/drm_atomic.c| 71 ++--- drivers/gpu/drm/drm_blend.c | 11 +++--- drivers/gpu/drm/drm_connector.c | 12 +++ drivers/gpu/drm/drm_crtc.c | 7 ++-- drivers/gpu/drm/drm_dumb_buffers.c | 4 +-- drivers/gpu/drm/drm_encoder.c | 2 +- drivers/gpu/drm/drm_encoder_slave.c | 2 +- drivers/gpu/drm/drm_framebuffer.c | 10 +++--- drivers/gpu/drm/drm_modeset_lock.c | 10 +++--- drivers/gpu/drm/drm_plane.c | 2 +- drivers/gpu/drm/drm_property.c | 2 +- include/drm/drm_atomic.h| 6 ++-- include/drm/drm_color_mgmt.h| 2 +- include/drm/drm_connector.h | 40 ++--- include/drm/drm_crtc.h | 29 +++ include/drm/drm_framebuffer.h | 15 include/drm/drm_mode_config.h | 12 +++ include/drm/drm_mode_object.h | 13 --- include/drm/drm_modeset_lock.h | 2 +- include/drm/drm_plane.h | 18 +- include/drm/drm_property.h | 8 ++--- 21 files changed, 141 insertions(+), 137 deletions(-) diff --git a/drivers/gpu/drm/drm_atomic.c b/drivers/gpu/drm/drm_atomic.c index 723392fc98c8..96c81a61a542 100644 --- a/drivers/gpu/drm/drm_atomic.c +++ b/drivers/gpu/drm/drm_atomic.c @@ -195,8 +195,8 @@ EXPORT_SYMBOL(drm_atomic_state_default_clear); * all locks. So someone else could sneak in and change the current modeset * configuration. Which means that all the state assembled in @state is no * longer an atomic update to the current state, but to some arbitrary earlier - * state. Which could break assumptions the driver's ->atomic_check likely - * relies on. + * state. Which could break assumptions the driver's + * &drm_mode_config_funcs.atomic_check likely relies on. * * Hence we must clear all cached state and completely start over, using this * function. @@ -456,11 +456,10 @@ drm_atomic_replace_property_blob_from_id(struct drm_crtc *crtc, * @property: the property to set * @val: the new property value * - * Use this instead of calling crtc->atomic_set_property directly. - * This function handles generic/core properties and calls out to - * driver's ->atomic_set_property() for driver properties. To ensure - * consistent behavior you must call this function rather than the - * driver hook directly. + * This function handles generic/core properties and calls out to driver's + * &drm_crtc_funcs.atomic_set_property for driver properties. To ensure + * consistent behavior you must call this function rather than the driver hook + * directly. * * RETURNS: * Zero on success, error code on failure @@ -532,10 +531,10 @@ EXPORT_SYMBOL(drm_atomic_crtc_set_property); * @property: the property to set * @val: return location for the property value * - * This function handles generic/core properties and calls out to - * driver's ->atomic_get_property() for driver properties. To ensure - * consistent behavior you must call this function rather than the - * driver hook directly. + * This function handles generic/core properties and calls out to driver's + * &drm_crtc_funcs.atomic_get_property for driver properties. To ensure + * consistent behavior you must call this function rather than the driver hook + * directly. * * RETURNS: * Zero on success, error code on failure @@ -716,11 +715,10 @@ EXPORT_SYMBOL(drm_atomic_get_plane_state); * @property: the property to set * @val: the new property value * - * Use this instead of calling plane->atomic_set_property directly. - * This function handles generic/core properties and calls out to - * driver's ->atomic_set_property() for driver properties. To ensure - * consistent behavior you must call this function rather than the - * driver hook directly. + * This function handles generic/core properties and calls out to driver's + * &drm_plane_funcs.atomic_set_property for driver properties. To ensure + * consistent behavior you must call this function rather than the driver hook + * directly. * * RETURNS: * Zero on success, error code on failure @@ -791,10 +789,10 @@ EXPORT_SYMBOL(drm_atomic_plane_set_property); * @property: the property to set * @val: return location for the property value * - * This function handles generic/core properties and calls out to - * driver's ->atomic_get_property() for driver properties. To ensure - * consistent behavior you must call this function rather than the - * driver hook directly. + * This function handles generic/core properties and calls out to driver's + * &drm_plane_funcs.atomic_get_property for drive
Re: [Intel-gfx] [PATCH 03/15] drm/kms-core: Use recommened kerneldoc for struct member refs
On Wednesday, 2017-01-25 07:26:45 +0100, Daniel Vetter wrote: > I just learned that &struct_name.member_name works and looks pretty > even. It doesn't (yet) link to the member directly though, which would > be really good for big structures or vfunc tables (where the > per-member kerneldoc tends to be long). > > Also some minor drive-by polish where it makes sense, I read a lot > of docs ... > > Cc: Jani Nikula > Cc: Chris Wilson > Signed-off-by: Daniel Vetter > --- > drivers/gpu/drm/drm_atomic.c| 71 > ++--- > drivers/gpu/drm/drm_blend.c | 11 +++--- > drivers/gpu/drm/drm_connector.c | 12 +++ > drivers/gpu/drm/drm_crtc.c | 7 ++-- > drivers/gpu/drm/drm_dumb_buffers.c | 4 +-- > drivers/gpu/drm/drm_encoder.c | 2 +- > drivers/gpu/drm/drm_encoder_slave.c | 2 +- > drivers/gpu/drm/drm_framebuffer.c | 10 +++--- > drivers/gpu/drm/drm_modeset_lock.c | 10 +++--- > drivers/gpu/drm/drm_plane.c | 2 +- > drivers/gpu/drm/drm_property.c | 2 +- > include/drm/drm_atomic.h| 6 ++-- > include/drm/drm_color_mgmt.h| 2 +- > include/drm/drm_connector.h | 40 ++--- > include/drm/drm_crtc.h | 29 +++ > include/drm/drm_framebuffer.h | 15 > include/drm/drm_mode_config.h | 12 +++ > include/drm/drm_mode_object.h | 13 --- > include/drm/drm_modeset_lock.h | 2 +- > include/drm/drm_plane.h | 18 +- > include/drm/drm_property.h | 8 ++--- > 21 files changed, 141 insertions(+), 137 deletions(-) > > diff --git a/drivers/gpu/drm/drm_atomic.c b/drivers/gpu/drm/drm_atomic.c > index 723392fc98c8..96c81a61a542 100644 > --- a/drivers/gpu/drm/drm_atomic.c > +++ b/drivers/gpu/drm/drm_atomic.c > @@ -195,8 +195,8 @@ EXPORT_SYMBOL(drm_atomic_state_default_clear); > * all locks. So someone else could sneak in and change the current modeset > * configuration. Which means that all the state assembled in @state is no > * longer an atomic update to the current state, but to some arbitrary > earlier > - * state. Which could break assumptions the driver's ->atomic_check likely > - * relies on. > + * state. Which could break assumptions the driver's > + * &drm_mode_config_funcs.atomic_check likely relies on. > * > * Hence we must clear all cached state and completely start over, using this > * function. > @@ -456,11 +456,10 @@ drm_atomic_replace_property_blob_from_id(struct > drm_crtc *crtc, > * @property: the property to set > * @val: the new property value > * > - * Use this instead of calling crtc->atomic_set_property directly. > - * This function handles generic/core properties and calls out to > - * driver's ->atomic_set_property() for driver properties. To ensure > - * consistent behavior you must call this function rather than the > - * driver hook directly. > + * This function handles generic/core properties and calls out to driver's > + * &drm_crtc_funcs.atomic_set_property for driver properties. To ensure > + * consistent behavior you must call this function rather than the driver > hook > + * directly. > * > * RETURNS: > * Zero on success, error code on failure > @@ -532,10 +531,10 @@ EXPORT_SYMBOL(drm_atomic_crtc_set_property); > * @property: the property to set > * @val: return location for the property value > * > - * This function handles generic/core properties and calls out to > - * driver's ->atomic_get_property() for driver properties. To ensure > - * consistent behavior you must call this function rather than the > - * driver hook directly. > + * This function handles generic/core properties and calls out to driver's > + * &drm_crtc_funcs.atomic_get_property for driver properties. To ensure > + * consistent behavior you must call this function rather than the driver > hook > + * directly. > * > * RETURNS: > * Zero on success, error code on failure > @@ -716,11 +715,10 @@ EXPORT_SYMBOL(drm_atomic_get_plane_state); > * @property: the property to set > * @val: the new property value > * > - * Use this instead of calling plane->atomic_set_property directly. > - * This function handles generic/core properties and calls out to > - * driver's ->atomic_set_property() for driver properties. To ensure > - * consistent behavior you must call this function rather than the > - * driver hook directly. > + * This function handles generic/core properties and calls out to driver's > + * &drm_plane_funcs.atomic_set_property for driver properties. To ensure > + * consistent behavior you must call this function rather than the driver > hook > + * directly. > * > * RETURNS: > * Zero on success, error code on failure > @@ -791,10 +789,10 @@ EXPORT_SYMBOL(drm_atomic_plane_set_property); > * @property: the property to set > * @val: return location for the property value > * > - * This function handles generic/core properties and calls out to > - * dr
