On Thu, Nov 04, 2021 at 01:05:51PM -0600, Jonathan Corbet wrote: > Beau Belgrave <beaub@xxxxxxxxxxxxxxxxxxx> 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@xxxxxxxxxxxxxxxxxxx> > > --- > > 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
|