From nobody Mon Feb 24 17:35:01 2025 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4Z1ntZ2x7rz5pXTj; Mon, 24 Feb 2025 17:35:02 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Z1ntY6TS3z3rFl; Mon, 24 Feb 2025 17:35:01 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1740418501; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Jljqb6mLF4U79GZD/wpmP5lUm8ormDOadt+XfSiHC1o=; b=Z4uzi3CwB+Nvvp7QuUNbv2FTzXPZ8iJAeGxzo2SsPtPf2eYd3vYtGEd0y8YS9B3HiK4Zgy 85SksYj9Ggkc0/XS09wIXZNHsp1h+sb4oSfCwNsUl1oWK9CyqXbfluGTznlpR8OCUBkH4d ceBB5d8w+5R+ABeLoexYoid/Z360uropeBL8rTfx5mbM6ojnWGTX1oJ1aO1RK4xe50ov90 xbO+k/Hu72b/3bPIA3of2CK33mAeeCQbe2+OI2vo22OrY6UWDYCoQXX3VEcsDdg2EIMY+7 bFcbCUW67L+HMjUDEMLzFJdX1bsNieMmNpAEh7T+C4UOOIwpIY0n3w27Tb1rDQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1740418501; a=rsa-sha256; cv=none; b=OWaH/mk5Y5OU9eH05q0BIw6Hg0JGfilITks6q135Nuf6TIqYC/H++jtQziAu1b5nPtZTmj N2E9FOQXL2PxfASbpC6UQHGf0BjbHVMTkqL83eR+aGhNiU+zaHW9jieNebM3PVNLaPC3yl LuGwhSOZ2I3I+55geVrYeFNWMHGpwwxerYwbd1oJ9JGPMGkS8y0rbCmJ6SllSSqUWOWa3k BbA7je451DVhWiAocPQCgHrKjkCR8kFOxbtCT/XOFEMFgO0Ndx+nDPUxk1OiNblktrE9PJ RfB8dEHHaX0QUd4+MuLccOfgMWqAdZ58MZ8lg7Tk09CC9nNjaX8Qav+MPcEvpw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1740418501; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Jljqb6mLF4U79GZD/wpmP5lUm8ormDOadt+XfSiHC1o=; b=P+TZsdaFfY+P/wdLjIYRHQvpEPPNSs4tQTd4CXL9z9HutrKnqURZXWXTt0bm0K6Byj+/GH ldTpKURlHVGtrkZ9sx7O96YtHywGPsP1BdEdcOKfahHeTaKGwyBhzUc9Oq3Jsj8PRZtr0Z 4VDGbzGdJ5hfxet7DoSNrjanyI8e1MKpxlTgLcptCdlUMB1fYZUGODvucO2t5ym17iTyfy r3LPp64zWkc9iMJ2BMR0fqYXal/wbn3iFVI4jFHuOq4J32spIvCS7D0HbsyqmaBVNRODgh Bida87GBVDl7tzvNl6jgkX1vxgEQmlND44edwv3+3YKmEvSDBV47t0NeOJ1Dhg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4Z1ntY5vY4zqpd; Mon, 24 Feb 2025 17:35:01 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 51OHZ1B3008794; Mon, 24 Feb 2025 17:35:01 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 51OHZ1OQ008791; Mon, 24 Feb 2025 17:35:01 GMT (envelope-from git) Date: Mon, 24 Feb 2025 17:35:01 GMT Message-Id: <202502241735.51OHZ1OQ008791@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Alexander Ziaee Subject: git: 7c3c8605d62f - main - recv.2: Improve style in RETURN VALUES List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ziaee X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 7c3c8605d62f5d27a5228a3787aae6e573f77d59 Auto-Submitted: auto-generated The branch main has been updated by ziaee: URL: https://cgit.FreeBSD.org/src/commit/?id=7c3c8605d62f5d27a5228a3787aae6e573f77d59 commit 7c3c8605d62f5d27a5228a3787aae6e573f77d59 Author: Alexander Ziaee AuthorDate: 2025-02-24 17:33:24 +0000 Commit: Alexander Ziaee CommitDate: 2025-02-24 17:33:38 +0000 recv.2: Improve style in RETURN VALUES Reported by: des MFC after: 3 days Fixes: 571df2c64a3c1 (Explain how recv functions can) Reviewed by: mhorne, des Approved by: mhorne (mentor) Differential Revision: https://reviews.freebsd.org/D48995 --- lib/libsys/recv.2 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/libsys/recv.2 b/lib/libsys/recv.2 index 9dc1f3cc84ca..f3ee60b75663 100644 --- a/lib/libsys/recv.2 +++ b/lib/libsys/recv.2 @@ -316,14 +316,14 @@ On data reception the .Fa msg_len field is updated to the length of the received message. .Sh RETURN VALUES -On successful completion, +On successful completion, the .Fn recv , .Fn recvfrom , and .Fn recvmsg -return the number of bytes received. +functions return the number of bytes received, while the .Fn recvmmsg -returns the number of messages received. +function returns the number of messages received. If no messages are available to be received and the peer has performed an orderly shutdown, 0 is returned. Otherwise, -1 is returned and