Re: [PATCH] Documentation: Document user_events ioctl code

[Mathieu Desnoyers <mathieu.desnoyers@efficios.com>]

On 03-Jul-2024 10:25:01 PM, Beau Belgrave wrote:
> The user events trace subsystem uses the 0x2A/'*' code for ioctls. These
> are published via the uapi/linux/user_events.h header file.
> 
> Add a line indicating user events as the owner of the 0x2A/'*' code and the
> current sequence numbers that are in use (00-02).
> 
> Signed-off-by: Beau Belgrave <beaub@linux.microsoft.com>
> ---
>  Documentation/userspace-api/ioctl/ioctl-number.rst | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/userspace-api/ioctl/ioctl-number.rst b/Documentation/userspace-api/ioctl/ioctl-number.rst
> index a141e8e65c5d..191609fe4593 100644
> --- a/Documentation/userspace-api/ioctl/ioctl-number.rst
> +++ b/Documentation/userspace-api/ioctl/ioctl-number.rst
> @@ -97,6 +97,8 @@ Code  Seq#    Include File                                           Comments
>  '%'   00-0F  include/uapi/linux/stm.h                                System Trace Module subsystem
>                                                                       <mailto:alexander.shishkin@linux.intel.com>
>  '&'   00-07  drivers/firewire/nosy-user.h
> +'*'   00-02  uapi/linux/user_events.h                                User Events Subsystem

You may want to consider reserving a wider sequence number range to plan
ahead for future extensions to user events. This way you won't end up
having to jump over sequence numbers eventually reserved by others
within the '*' code.

Thanks,

Mathieu


> +                                                                     <mailto:linux-trace-kernel@vger.kernel.org>
>  '1'   00-1F  linux/timepps.h                                         PPS kit from Ulrich Windl
>                                                                       <ftp://ftp.de.kernel.org/pub/linux/daemons/ntp/PPS/>
>  '2'   01-04  linux/i2o.h
> -- 
> 2.34.1
> 

-- 
Mathieu Desnoyers
EfficiOS Inc.
http://www.efficios.com