linux-kernel - Re: [PATCH v4 10/10] user_events: Add documentation file

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20211104210809.GA2486@kbox>
Date:   Thu, 4 Nov 2021 14:08:09 -0700
From:   Beau Belgrave <beaub@...ux.microsoft.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     rostedt@...dmis.org, mhiramat@...nel.org,
        linux-trace-devel@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4 10/10] user_events: Add documentation file

On Thu, Nov 04, 2021 at 01:05:51PM -0600, Jonathan Corbet wrote:
> Beau Belgrave <beaub@...ux.microsoft.com> writes:
> 
> > Add a documentation file about user_events with example code, etc.
> > explaining how it may be used.
> 
> Yay documentation!  Some nits for a slow moment...
> 
> > Signed-off-by: Beau Belgrave <beaub@...ux.microsoft.com>
> > ---
> >  Documentation/trace/user_events.rst | 298 ++++++++++++++++++++++++++++
> >  1 file changed, 298 insertions(+)
> >  create mode 100644 Documentation/trace/user_events.rst
> 
> Actually, this isn't really a nit.  When you add a new RST file, you
> need to add it to the index.rst file too so that it gets pulled into the
> docs build.  Otherwise you'll get the warning you doubtless saw when you
> tried building the docs after adding this file...:)
> 

Thanks for the review, I'll fix these things up!

> > +Example Code
> > +------------
> 
> Examples are great, but they are best placed under samples/ (or tools/
> if they do something useful) where readers can build and run them.
> 

Ok, sounds good. Is it fine to include user mode samples in there? I
quickly checked and most appear to be modules. Maybe there is a better
place for user mode examples?

Thanks,
-Beau