Re: [PATCH v3 1/1] ioctl_eventpoll.2: New page describing epoll ioctl(2)

[Joe Damato <jdamato@fastly.com>]

On Tue, Jun 11, 2024 at 10:37:20PM +0200, Alejandro Colomar wrote:
> Hi Joe,
> 
> On Tue, Jun 11, 2024 at 01:29:50PM GMT, Joe Damato wrote:
> > > > diff --git a/man/man2/ioctl_eventpoll.2 b/man/man2/ioctl_eventpoll.2
> > > > new file mode 100644
> > > > index 000000000..0fe03d6d4
> > > > --- /dev/null
> > > > +++ b/man/man2/ioctl_eventpoll.2
> > > > @@ -0,0 +1,173 @@
> > > > +.\" Copyright (c) 2024, Joe Damato
> > > 
> > > 1d
> > 
> > My apologies, but I am not sure what you mean by this. What does 1d
> > mean?
> 
> I meant `sed -i 1d`.  This line was redundant with line 2.

Ah, of course. I've removed that line above and left the line below
instead.

> > > > +.\" Copyright 2024, Joe Damato <jdamato@fastly.com>
> > > > +.\"
> > > > +.\" SPDX-License-Identifier: Linux-man-pages-copyleft
> > > > +.\"
> 
> [...]
> 
> > > Also, I'd like to align the member names according to
> > > <https://nginx.org/en/docs/dev/development_guide.html#code_style_variables>.
> > > That is, 2 spaces of minimum alignment, plus the necessary to make them
> > > all aligned (so 3 on the last).
> > > 
> > > I'd like also 2 spaces minimum before the comments, instead of just 1.
> > 
> > OK, based on the link you sent, I've aligned the start of each of
> > the types and then aligned the start of the field names. Lastly,
> > I've aligned the start of the comments for the first 3 fields, but
> > left the comment for the __pad just two spaces after the field name.
> > 
> > Did you want the comment for __pad to be aligned to the comments for
> > the in-use fields above?
> > 
> > This is what I have now, but I can insert space to move the pad comment over if
> > you like.
> > 
> > .EX
> > .B struct epoll_params {
> > .BR "  uint32_t busy_poll_usecs;" "   /* Number of usecs to busy poll */"
> > .BR "  uint16_t busy_poll_budget;" "  /* Max packets per poll */"
> > .BR "  uint8_t  prefer_busy_poll;" "  /* Boolean preference  */"
> > \&
> > .BR " " "/* pad the struct to a multiple of 64bits */"
> > .BR "  uint8_t  __pad;" "  /* Must be zero */"
> > .B };
> > .EE
> 
> LGTM.
> 
> [...]
> 
> > > Please also add a STANDARDS section, which just says "Linux."
> > 
> > OK added STANDARDS (in the order above) which just says Linux:
> > 
> > .SH STANDARDS
> > .P
> 
> .P after .SH is redundant.

Fixed.

Will push a v4 shortly after re-reading this one.
 
> > Linux.
> > .SH HISTORY
> > 
> > > Regarding semantic newlines, it looks great.  Thanks!
> > 
> > Great!
> 
> Have a lovely night!
> Alex
> 
> -- 
> <https://www.alejandro-colomar.es/>