From mboxrd@z Thu Jan 1 00:00:00 1970 From: Gustavo Padovan Subject: Re: [PATCH] dma-buf/sync_file: fix documentation error Date: Mon, 19 Sep 2016 09:10:22 -0300 Message-ID: <20160919121022.GH13282@joana> References: <20160919042120.6280-1-emilio.lopez@collabora.co.uk> Mime-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: 8BIT Return-path: Content-Disposition: inline In-Reply-To: <20160919042120.6280-1-emilio.lopez@collabora.co.uk> Sender: linux-kernel-owner@vger.kernel.org To: Emilio =?iso-8859-1?Q?L=F3pez?= Cc: sumit.semwal@linaro.org, dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org List-Id: dri-devel@lists.freedesktop.org Hi Emilio, 2016-09-19 Emilio López : > The ioctl name and description on the documentation block don't > match the ioctl being defined. This was probably overlooked while > renaming the ioctls during the sync file destaging. This patch > provides a more accurate description of what the ioctl actually does. > > Signed-off-by: Emilio López > --- > > This is something I saw while refreshing my kselftest patches. Hopefully > this patch describes the new ioctl well enough, let me know if you > think it doesn't :) > > Cheers, > Emilio > > include/uapi/linux/sync_file.h | 13 +++++-------- > 1 file changed, 5 insertions(+), 8 deletions(-) > > diff --git a/include/uapi/linux/sync_file.h b/include/uapi/linux/sync_file.h > index 413303d..cdf8ec2 100644 > --- a/include/uapi/linux/sync_file.h > +++ b/include/uapi/linux/sync_file.h > @@ -85,15 +85,12 @@ struct sync_file_info { > #define SYNC_IOC_MERGE _IOWR(SYNC_IOC_MAGIC, 3, struct sync_merge_data) > > /** > - * DOC: SYNC_IOC_FENCE_INFO - get detailed information on a fence > + * DOC: SYNC_IOC_FILE_INFO - get detailed information on a sync_file > * > - * Takes a struct sync_file_info_data with extra space allocated for pt_info. > - * Caller should write the size of the buffer into len. On return, len is > - * updated to reflect the total size of the sync_file_info_data including > - * pt_info. > - * > - * pt_info is a buffer containing sync_pt_infos for every sync_pt in the fence. > - * To iterate over the sync_pt_infos, use the sync_pt_info.len field. > + * Takes a struct sync_file_info. If num_fences is 0, the field is updated > + * with the actual number of fences. If num_fences is > 0, the system will > + * use the pointer provided on sync_fence_info to return up to num_fences of > + * struct sync_fence_info, with detailed fence information. > */ Reviewed-by: Gustavo Padovan Gustavo