All of lore.kernel.org
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx@kernel.org>
To: Fedor Lapshin <fe.lap.prog@gmail.com>
Cc: linux-man@vger.kernel.org
Subject: Re: [patch] getgrouplist.3: tfix in example
Date: Sat, 16 Mar 2024 01:27:14 +0100	[thread overview]
Message-ID: <ZfTnYiGBuXUDzWzG@debian> (raw)
In-Reply-To: <CAJ_gjBp=_zdy3p3HdWSDD9XHexfNznhwSSCkASe-c71FHA99wg@mail.gmail.com>

[-- Attachment #1: Type: text/plain, Size: 2357 bytes --]

Hi Fedor,

On Wed, Mar 06, 2024 at 07:13:31PM +0300, Fedor Lapshin wrote:
> In example of getgrouplist, if getpwnam returns NULL, the program
> exits. The exit code EXIT_SUCCESS looks like a mistake, since the
> program also calls perror right before.
> 
> This patch changes the exit code to EXIT_FAILURE.

While your patch seems correct, it's not the only problem I see with
this call to getpwnam(3): it should clear errno before the call, since
a return of NULL doesn't necessarily mean an error.  See getpwnam(3):

$ MANWIDTH=72 man getpwnam | sed -n '/^RETURN/,/^$/p'
RETURN VALUE
     The getpwnam() and getpwuid() functions return  a  pointer  to  a
     passwd  structure,  or NULL if the matching entry is not found or
     an error occurs.  If an error occurs, errno is  set  to  indicate
     the error.  If one wants to check errno after the call, it should
     be set to zero before the call.

So I would also add 'errno = 0;' before the call, and then name the
commit something like

	getgrouplist.3: EXAMPLES: Fix error handling after getpwnam(3)

> 
> Best regards, Fedor.

Would you mind signing the patch?  See <./CONTRIBUTING.d/patches>:

       -  Sign your patch with "Signed-off-by:".  Read about the
          "Developer's Certificate of Origin" at
          <https://www.kernel.org/doc/Documentation/process/submitting-patches.rst>.
          When appropriate, other tags documented in that file, such as
          "Reported-by:", "Reviewed-by:", "Acked-by:", and
          "Suggested-by:" can be added to the patch.  The man-pages
          project also uses a "Cowritten-by:" tag with the obvious
          meaning.  Example:

              Signed-off-by: Alejandro Colomar <alx@kernel.org>


Have a lovely night!
Alex

> ---
>  man3/getgrouplist.3 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/man3/getgrouplist.3 b/man3/getgrouplist.3
> index 41389b6c3..239913ce6 100644
> --- a/man3/getgrouplist.3
> +++ b/man3/getgrouplist.3
> @@ -165,7 +165,7 @@ main(int argc, char *argv[])
>      pw = getpwnam(argv[1]);
>      if (pw == NULL) {
>          perror("getpwnam");
> -        exit(EXIT_SUCCESS);
> +        exit(EXIT_FAILURE);
>      }
>  \&
>      /* Retrieve group list. */
> -- 
> 2.34.1

-- 
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  reply	other threads:[~2024-03-16  0:27 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-06 16:13 [patch] getgrouplist.3: tfix in example Fedor Lapshin
2024-03-16  0:27 ` Alejandro Colomar [this message]
2024-03-27 19:20   ` [PATCH] getgrouplist.3: EXAMPLES: fix error handling for getpwnam(3) Fedor Lapshin
2024-03-27 19:23     ` Fedor Lapshin
2024-03-27 20:14       ` Alejandro Colomar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ZfTnYiGBuXUDzWzG@debian \
    --to=alx@kernel.org \
    --cc=fe.lap.prog@gmail.com \
    --cc=linux-man@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.