linux-kernel - Re: [PATCH] doc: add kernel-doc comment for u64_to_user

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20230102191521.zbcnkfh22bftutng@numero-86.vaga.pv.it>
Date:   Mon, 2 Jan 2023 20:15:21 +0100
From:   Federico Vaga <federico.vaga@...a.pv.it>
To:     Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
Cc:     Jonathan Corbet <corbet@....net>, Jens Axboe <axboe@...nel.dk>,
        Keith Busch <kbusch@...nel.org>,
        Peter Zijlstra <peterz@...radead.org>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Mark Rutland <mark.rutland@....com>,
        Mikulas Patocka <mpatocka@...hat.com>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] doc: add kernel-doc comment for u64_to_user_ptr

On Mon, Jan 02, 2023 at 09:03:34PM +0200, Andy Shevchenko wrote:
>On Mon, Jan 02, 2023 at 07:43:49PM +0100, Federico Vaga wrote:
>> Add a kernel-doc comment in kernel.h to document the macro
>> `u64_to_user_ptr`.
>
>We refer functions as func(), so `u64_to_user_ptr` --> u64_to_user_ptr().
>
>> As of today, this macro is mentioned in the documentation in
>> 'ioctl.rst' and 'botching-up-ioctls.rst'
>
>Missing period at the end.
>
>...
>
>> +/**
>> + * u64_to_user_ptr - convert an unsigned 64bit number into a user pointer
>
>64-bit
>
>> + * @x: the number to convert
>
>Isn't 'number' is a bit misleading here?
>It decodes the user pointer, that is encoded into unsigned 64-bit value.
>Unfortunately I am not a native speaker, I can't propose anything better.
>It might be that the 'number' is quite good choice, dunno.

I agree about the macro's purpose. However, it does its job even if the 64-bit
value isn't a valid pointer (and this is what you will get). For this reason I
used a generic "number".

>> + */
>
>-- 
>With Best Regards,
>Andy Shevchenko
>
>

-- 
Federico Vaga