Re: [PATCH v3] drm/i915: Clean up ancient doc comments for i915_ioc32.c

[Jani Nikula <jani.nikula@linux.intel.com>]

On Thu, 15 Feb 2018, Chris Wilson <chris@chris-wilson.co.uk> wrote:
> Quoting Chris Wilson (2018-02-14 16:07:20)
>> As befitting a file dedicated to the mistakes of the past,
>> 
>> drivers/gpu/drm/i915/i915_ioc32.c:2: warning: Cannot understand  * \file i915_ioc32.c
>>  on line 2 - I thought it was a doc line
>> drivers/gpu/drm/i915/i915_ioc32.c:82: warning: Function parameter or member 'filp' not described in 'i915_compat_ioctl'
>> drivers/gpu/drm/i915/i915_ioc32.c:82: warning: Function parameter or member 'cmd' not described in 'i915_compat_ioctl'
>> drivers/gpu/drm/i915/i915_ioc32.c:82: warning: Function parameter or member 'arg' not described in 'i915_compat_ioctl'
>> 
>> Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>
>> ---
>> Don't drop the fixes this time!
>
> Are we happy with this no-nonsense version?

Reviewed-by: Jani Nikula <jani.nikula@intel.com>

>
>> ---
>>  drivers/gpu/drm/i915/i915_ioc32.c | 27 ++++++++++++---------------
>>  1 file changed, 12 insertions(+), 15 deletions(-)
>> 
>> diff --git a/drivers/gpu/drm/i915/i915_ioc32.c b/drivers/gpu/drm/i915/i915_ioc32.c
>> index 97f3a5640289..0e5c580d117c 100644
>> --- a/drivers/gpu/drm/i915/i915_ioc32.c
>> +++ b/drivers/gpu/drm/i915/i915_ioc32.c
>> @@ -1,11 +1,6 @@
>> -/**
>> - * \file i915_ioc32.c
>> - *
>> +/*
>>   * 32-bit ioctl compatibility routines for the i915 DRM.
>>   *
>> - * \author Alan Hourihane <alanh@fairlite.demon.co.uk>
>> - *
>> - *
>>   * Copyright (C) Paul Mackerras 2005
>>   * Copyright (C) Alan Hourihane 2005
>>   * All Rights Reserved.
>> @@ -28,6 +23,8 @@
>>   * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
>>   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
>>   * IN THE SOFTWARE.
>> + *
>> + * Author: Alan Hourihane <alanh@fairlite.demon.co.uk>
>>   */
>>  #include <linux/compat.h>
>>  
>> @@ -55,10 +52,10 @@ static int compat_i915_getparam(struct file *file, unsigned int cmd,
>>                 return -EFAULT;
>>  
>>         request = compat_alloc_user_space(sizeof(*request));
>> -       if (!access_ok(VERIFY_WRITE, request, sizeof(*request))
>> -           || __put_user(req32.param, &request->param)
>> -           || __put_user((void __user *)(unsigned long)req32.value,
>> -                         &request->value))
>> +       if (!access_ok(VERIFY_WRITE, request, sizeof(*request)) ||
>> +           __put_user(req32.param, &request->param) ||
>> +           __put_user((void __user *)(unsigned long)req32.value,
>> +                      &request->value))
>>                 return -EFAULT;
>>  
>>         return drm_ioctl(file, DRM_IOCTL_I915_GETPARAM,
>> @@ -70,13 +67,13 @@ static drm_ioctl_compat_t *i915_compat_ioctls[] = {
>>  };
>>  
>>  /**
>> + * i915_compat_ioctl - handle the mistakes of the past
>> + * @filp: the file pointer
>> + * @cmd: the ioctl command (and encoded flags)
>> + * @arg: the ioctl argument (from userspace)
>> + *
>>   * Called whenever a 32-bit process running under a 64-bit kernel
>>   * performs an ioctl on /dev/dri/card<n>.
>> - *
>> - * \param filp file pointer.
>> - * \param cmd command.
>> - * \param arg user argument.
>> - * \return zero on success or negative number on failure.
>>   */
>>  long i915_compat_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
>>  {
>> -- 
>> 2.16.1
>> 
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx