On Thu, May 02, 2024 at 03:43:27PM +0200, Alejandro Colomar wrote: > Hi Jiri, > > On Thu, May 02, 2024 at 02:23:13PM +0200, Jiri Olsa wrote: > > Adding man page for new uretprobe syscall. > > > > Signed-off-by: Jiri Olsa <jolsa@xxxxxxxxxx> > > --- > > man2/uretprobe.2 | 45 +++++++++++++++++++++++++++++++++++++++++++++ > > 1 file changed, 45 insertions(+) > > create mode 100644 man2/uretprobe.2 > > > > diff --git a/man2/uretprobe.2 b/man2/uretprobe.2 > > new file mode 100644 > > index 000000000000..08fe6a670430 > > --- /dev/null > > +++ b/man2/uretprobe.2 > > @@ -0,0 +1,45 @@ > > +.\" Copyright (C) 2024, Jiri Olsa <jolsa@xxxxxxxxxx> > > +.\" > > +.\" SPDX-License-Identifier: Linux-man-pages-copyleft > > +.\" > > +.TH uretprobe 2 (date) "Linux man-pages (unreleased)" > > +.SH NAME > > +uretprobe \- execute pending return uprobes > > +.SH SYNOPSIS > > +.nf > > +.B int uretprobe(void) > > +.fi > > +.SH DESCRIPTION > > +Kernel is using > > +.BR uretprobe() > > +syscall to trigger uprobe return probe consumers instead of using > > +standard breakpoint instruction. > > + > > Please use .P instead of a blank. See man-pages(7): > > Formatting conventions (general) > Paragraphs should be separated by suitable markers (usually either > .P or .IP). Do not separate paragraphs using blank lines, as this > results in poor rendering in some output formats (such as Post‐ > Script and PDF). ok, will do > > > +The uretprobe syscall is not supposed to be called directly by user, it's allowed > > s/by user/by the user/ ok > > > +to be invoked only through user space trampoline provided by kernel. > > s/user space/user-space/ ok > > Missing a few 'the' too, here and in the rest of the page. ok, will check > > > +When called from outside of this trampoline, the calling process will receive > > +.BR SIGILL . > > + > > +.SH RETURN VALUE > > +.BR uretprobe() > > You're missing a space here: > > .BR uretprobe () ok > > > +return value is specific for given architecture. > > + > > +.SH VERSIONS > > +This syscall is not specified in POSIX, > > +and details of its behavior vary across systems. > > +.SH STANDARDS > > +None. > > You could add a HISTORY section. ok, IIUC for this syscall it should contain just kernel version where it got merged, right? > > Have a lovely day! thanks for review, jirka
