| Message ID | 1559159944-21103-4-git-send-email-uma.shankar@intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Document fixes for DRM UAPI and HDR | expand |
On Thu, May 30, 2019 at 01:29:03AM +0530, Uma Shankar wrote: > Fixed doc warnings in drm uapi header. All the UAPI > structures are now documented in kernel doc. > > Signed-off-by: Uma Shankar <uma.shankar@intel.com> Applied, thanks for the patch. Long-term there's obviously a lot more to do here, but this at least gets us started. Btw I think it'd be good to split out the "add new uapi ioctl structures section" part from the previous patch, and merge that separately. Thanks, Daniel > --- > include/uapi/drm/drm_mode.h | 22 ++++++++++++++++++++++ > 1 file changed, 22 insertions(+) > > diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h > index 5d3964f..02b2a2b 100644 > --- a/include/uapi/drm/drm_mode.h > +++ b/include/uapi/drm/drm_mode.h > @@ -861,6 +861,10 @@ struct drm_format_modifier { > }; > > /** > + * struct drm_mode_create_blob - Create New block property > + * @data: Pointer to data to copy. > + * @length: Length of data to copy. > + * @blob_id: new property ID. > * Create a new 'blob' data property, copying length bytes from data pointer, > * and returning new blob ID. > */ > @@ -874,6 +878,8 @@ struct drm_mode_create_blob { > }; > > /** > + * struct drm_mode_destroy_blob - Destroy user blob > + * @blob_id: blob_id to destroy > * Destroy a user-created blob property. > */ > struct drm_mode_destroy_blob { > @@ -881,6 +887,12 @@ struct drm_mode_destroy_blob { > }; > > /** > + * struct drm_mode_create_lease - Create lease > + * @object_ids: Pointer to array of object ids. > + * @object_count: Number of object ids. > + * @flags: flags for new FD. > + * @lessee_id: unique identifier for lessee. > + * @fd: file descriptor to new drm_master file. > * Lease mode resources, creating another drm_master. > */ > struct drm_mode_create_lease { > @@ -898,6 +910,10 @@ struct drm_mode_create_lease { > }; > > /** > + * struct drm_mode_list_lessees - List lessees > + * @count_lessees: Number of lessees. > + * @pad: pad. > + * @lessees_ptr: Pointer to lessess. > * List lesses from a drm_master > */ > struct drm_mode_list_lessees { > @@ -918,6 +934,10 @@ struct drm_mode_list_lessees { > }; > > /** > + * struct drm_mode_get_lease - Get Lease > + * @count_objects: Number of leased objects. > + * @pad: pad. > + * @objects_ptr: Pointer to objects. > * Get leased objects > */ > struct drm_mode_get_lease { > @@ -938,6 +958,8 @@ struct drm_mode_get_lease { > }; > > /** > + * struct drm_mode_revoke_lease - Revoke lease > + * @lessee_id: Unique ID of lessee. > * Revoke lease > */ > struct drm_mode_revoke_lease { > -- > 1.9.1 >
>-----Original Message----- >From: Daniel Vetter [mailto:daniel.vetter@ffwll.ch] On Behalf Of Daniel Vetter >Sent: Monday, June 3, 2019 1:56 PM >To: Shankar, Uma <uma.shankar@intel.com> >Cc: intel-gfx@lists.freedesktop.org; dri-devel@lists.freedesktop.org; >maarten.lankhorst@linux.intel.com; ville.syrjala@linux.intel.com; Sharma, Shashank ><shashank.sharma@intel.com>; emil.l.velikov@gmail.com; brian.starkey@arm.com; >dcastagna@chromium.org; seanpaul@chromium.org; Roper, Matthew D ><matthew.d.roper@intel.com>; jonas@kwiboo.se; daniel@ffwll.ch >Subject: Re: [PATCH 3/4] drm: Fixed doc warnings in drm uapi header > >On Thu, May 30, 2019 at 01:29:03AM +0530, Uma Shankar wrote: >> Fixed doc warnings in drm uapi header. All the UAPI structures are now >> documented in kernel doc. >> >> Signed-off-by: Uma Shankar <uma.shankar@intel.com> > >Applied, thanks for the patch. > >Long-term there's obviously a lot more to do here, but this at least gets us started. > >Btw I think it'd be good to split out the "add new uapi ioctl structures section" part >from the previous patch, and merge that separately. Ok, will do the same. Regards, Uma Shankar >Thanks, Daniel > >> --- >> include/uapi/drm/drm_mode.h | 22 ++++++++++++++++++++++ >> 1 file changed, 22 insertions(+) >> >> diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h >> index 5d3964f..02b2a2b 100644 >> --- a/include/uapi/drm/drm_mode.h >> +++ b/include/uapi/drm/drm_mode.h >> @@ -861,6 +861,10 @@ struct drm_format_modifier { }; >> >> /** >> + * struct drm_mode_create_blob - Create New block property >> + * @data: Pointer to data to copy. >> + * @length: Length of data to copy. >> + * @blob_id: new property ID. >> * Create a new 'blob' data property, copying length bytes from data pointer, >> * and returning new blob ID. >> */ >> @@ -874,6 +878,8 @@ struct drm_mode_create_blob { }; >> >> /** >> + * struct drm_mode_destroy_blob - Destroy user blob >> + * @blob_id: blob_id to destroy >> * Destroy a user-created blob property. >> */ >> struct drm_mode_destroy_blob { >> @@ -881,6 +887,12 @@ struct drm_mode_destroy_blob { }; >> >> /** >> + * struct drm_mode_create_lease - Create lease >> + * @object_ids: Pointer to array of object ids. >> + * @object_count: Number of object ids. >> + * @flags: flags for new FD. >> + * @lessee_id: unique identifier for lessee. >> + * @fd: file descriptor to new drm_master file. >> * Lease mode resources, creating another drm_master. >> */ >> struct drm_mode_create_lease { >> @@ -898,6 +910,10 @@ struct drm_mode_create_lease { }; >> >> /** >> + * struct drm_mode_list_lessees - List lessees >> + * @count_lessees: Number of lessees. >> + * @pad: pad. >> + * @lessees_ptr: Pointer to lessess. >> * List lesses from a drm_master >> */ >> struct drm_mode_list_lessees { >> @@ -918,6 +934,10 @@ struct drm_mode_list_lessees { }; >> >> /** >> + * struct drm_mode_get_lease - Get Lease >> + * @count_objects: Number of leased objects. >> + * @pad: pad. >> + * @objects_ptr: Pointer to objects. >> * Get leased objects >> */ >> struct drm_mode_get_lease { >> @@ -938,6 +958,8 @@ struct drm_mode_get_lease { }; >> >> /** >> + * struct drm_mode_revoke_lease - Revoke lease >> + * @lessee_id: Unique ID of lessee. >> * Revoke lease >> */ >> struct drm_mode_revoke_lease { >> -- >> 1.9.1 >> > >-- >Daniel Vetter >Software Engineer, Intel Corporation >http://blog.ffwll.ch
diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h index 5d3964f..02b2a2b 100644 --- a/include/uapi/drm/drm_mode.h +++ b/include/uapi/drm/drm_mode.h @@ -861,6 +861,10 @@ struct drm_format_modifier { }; /** + * struct drm_mode_create_blob - Create New block property + * @data: Pointer to data to copy. + * @length: Length of data to copy. + * @blob_id: new property ID. * Create a new 'blob' data property, copying length bytes from data pointer, * and returning new blob ID. */ @@ -874,6 +878,8 @@ struct drm_mode_create_blob { }; /** + * struct drm_mode_destroy_blob - Destroy user blob + * @blob_id: blob_id to destroy * Destroy a user-created blob property. */ struct drm_mode_destroy_blob { @@ -881,6 +887,12 @@ struct drm_mode_destroy_blob { }; /** + * struct drm_mode_create_lease - Create lease + * @object_ids: Pointer to array of object ids. + * @object_count: Number of object ids. + * @flags: flags for new FD. + * @lessee_id: unique identifier for lessee. + * @fd: file descriptor to new drm_master file. * Lease mode resources, creating another drm_master. */ struct drm_mode_create_lease { @@ -898,6 +910,10 @@ struct drm_mode_create_lease { }; /** + * struct drm_mode_list_lessees - List lessees + * @count_lessees: Number of lessees. + * @pad: pad. + * @lessees_ptr: Pointer to lessess. * List lesses from a drm_master */ struct drm_mode_list_lessees { @@ -918,6 +934,10 @@ struct drm_mode_list_lessees { }; /** + * struct drm_mode_get_lease - Get Lease + * @count_objects: Number of leased objects. + * @pad: pad. + * @objects_ptr: Pointer to objects. * Get leased objects */ struct drm_mode_get_lease { @@ -938,6 +958,8 @@ struct drm_mode_get_lease { }; /** + * struct drm_mode_revoke_lease - Revoke lease + * @lessee_id: Unique ID of lessee. * Revoke lease */ struct drm_mode_revoke_lease {
Fixed doc warnings in drm uapi header. All the UAPI structures are now documented in kernel doc. Signed-off-by: Uma Shankar <uma.shankar@intel.com> --- include/uapi/drm/drm_mode.h | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+)