Hi Amit,
> Subject: Re: [PATCH] [PATCH v1] man/man2/kill.2: Wording issue in kill(2) with sig=0
The first [PATCH] tag is redundant. Probably this was some accident
using the tools (I guess you wrote manually one of them and then the
tool added the other?). Nothing important; I'll just ignore it. Just
keep it in mind for the next patch you send.
On Wed, Feb 12, 2025 at 09:00:42PM +0200, Amit Pinhas wrote:
> The fix was found from the relevant man page itself, as it had a wording
> issue regarding the return value when sig=0.
>
> Reported-by: Amit Pinhas
> Acked-by: Alejandro Colomar
Good. You should use emails there too, but that's a minor detail.
> Signed-off-by: Amit Pinhas <amitpinhass@xxxxxxxxx>
> ---
> man/man2/kill.2 | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/man/man2/kill.2 b/man/man2/kill.2
> index 96468622e..8bb75545b 100644
> --- a/man/man2/kill.2
> +++ b/man/man2/kill.2
> @@ -79,7 +79,8 @@ .SH DESCRIPTION
> processes belong to the same session.
> (Historically, the rules were different; see HISTORY.)
> .SH RETURN VALUE
> -On success (at least one signal was sent), zero is returned.
> +On success, zero is returned. If signals were sent to a process
Please use semantic newlines. We have a man(7) source code style guide
in the man-pages(7) manual page. I recommend having a look at that
page.
For this case, here's the relevant paragraph:
$ MANWIDTH=72 man man-pages | sed -n '/Use semantic newlines/,/^$/p'
Use semantic newlines
In the source of a manual page, new sentences should be started on
new lines, long sentences should be split into lines at clause
breaks (commas, semicolons, colons, and so on), and long clauses
should be split at phrase boundaries. This convention, sometimes
known as "semantic newlines", makes it easier to see the effect of
patches, which often operate at the level of individual sentences,
clauses, or phrases.
> +group, success means that at least one signal was delivered.
Other than that, the patch looks good. Thanks! Please send v2
addressing the comment above. (It's simple enough, that I could just do
the amends myself, but that way you learn it better. ;)
Cheers,
Alex
> On error, \-1 is returned, and
> .I errno
> is set to indicate the error.
> --
> 2.43.0
>
--
<https://www.alejandro-colomar.es/>
Attachment:
signature.asc
Description: PGP signature
