From: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
To: Federico Vaga <federico.vaga@vaga.pv.it>
Cc: Jonathan Corbet <corbet@lwn.net>, Jens Axboe <axboe@kernel.dk>,
Keith Busch <kbusch@kernel.org>,
Peter Zijlstra <peterz@infradead.org>,
Andrew Morton <akpm@linux-foundation.org>,
Mark Rutland <mark.rutland@arm.com>,
Mikulas Patocka <mpatocka@redhat.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] doc: add kernel-doc comment for u64_to_user_ptr
Date: Mon, 2 Jan 2023 21:03:34 +0200 [thread overview]
Message-ID: <Y7MqhtPMYI4e50dY@smile.fi.intel.com> (raw)
In-Reply-To: <20230102184349.10399-1-federico.vaga@vaga.pv.it>
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.
> + */
--
With Best Regards,
Andy Shevchenko
next prev parent reply other threads:[~2023-01-02 19:03 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-02 18:43 [PATCH] doc: add kernel-doc comment for u64_to_user_ptr Federico Vaga
2023-01-02 19:03 ` Andy Shevchenko [this message]
2023-01-02 19:15 ` Federico Vaga
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=Y7MqhtPMYI4e50dY@smile.fi.intel.com \
--to=andriy.shevchenko@linux.intel.com \
--cc=akpm@linux-foundation.org \
--cc=axboe@kernel.dk \
--cc=corbet@lwn.net \
--cc=federico.vaga@vaga.pv.it \
--cc=kbusch@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=mpatocka@redhat.com \
--cc=peterz@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox