From nobody Thu Feb 27 01:45:24 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 4Z3DgT1MmNz5pRGv; Thu, 27 Feb 2025 01:45:25 +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 4Z3DgS4yM1z4Ppf; Thu, 27 Feb 2025 01:45:24 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1740620724; 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=TCiNxW9IohHODS0dQpYhWK4UADm8zp9wbC02sg53X9o=; b=SIKbaAQ4z9Yh31q+8JR0mjSvRkzPTmyvTfFSyPHEI4gNKGY3ScMFrNxcYs0tF5/15Qnysk 3Mp/CTeqw+yuBLWDxPNPNLYqhst0knZyDblaELufnkyKKY5E+pcwrCuLu6Oe3jl91TbBIY N9sdNasPeNGnMvOYpbTY+Nd4opfnJPHqRS4ANd8gxCKZ2ed8rN+C8BCZtIYpgEEEAQI7NP hRHdN5U3kuex7wVHAEidgMBkKCnAMIvDebq1wqF851CFrmZpDVe/tQEOmhFefyJ6Th1uxD MaC/9jWAwcN2pB/XAj/1/OvWvCYuZTlnbDot4kA2RK1RRinKsx84sk+eGHm7jg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1740620724; a=rsa-sha256; cv=none; b=QTbXICeomW/S68E8DLS8Xbbm9nIL5yi3BaE/oPDByXT8h5Fv8MFzUQth0epo22uVJaP5Jq QKiZR8JrQlmqxdXg6aTIwCJZAVRBM2pOMvQPfVhdRBugo6uyEgyjFj5YTy/oeNdOE+Wh3L vhpl70zYM+3BcRMKrftoh5nV6QWLSPnuuT3xhyvPtLQMrY9g3E5oQJa1UxxDfiqpCeZoXk 7xGic4jHfGMt55/Z5rfsEOR0UHBsaSEE68AfMupaxNdtPtQmJUb+fuvNxbGiCmUUM/YwaF bomk68ZnTv0CLbZmYG/6pD/dI4ERQ+tD4uXLnZbTECjENLmYloUv5rHLlFG5Qw== 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=1740620724; 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=TCiNxW9IohHODS0dQpYhWK4UADm8zp9wbC02sg53X9o=; b=bNu8GJiuJHZuziE/TGZ1J8eu0KZGwyfrOxHn2lMCEfWnH+hfgIiWjP9BUc14Hv34v0MPC+ 7QgkrTUmE2YhCJwI5crROq8U6JaYTtJ5dBZJ0Uup13Ln9SvBr8YY6LA6N7h2fnvnmQPZvY YOB954GyXHtv1M+xc7mqwksGxUIr57+fJCCKiCVyNVmiqqrUxgPZcg/OCgiT+FAaQfEeGg s/SN4jwssYbWJjiCBwORtanz3OkdEp0b5cBCx+sC4Skw/d2ytbIaJHU7xM0zqUZi1kXAvo ZhXvrk63uVBjFLjo0lqvkGIh7qPnr+qiePYXoc3IMRmpUU6pbw5d4AovSpF/fw== 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 4Z3DgS4Hfhz69Z; Thu, 27 Feb 2025 01:45:24 +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 51R1jO8L011441; Thu, 27 Feb 2025 01:45:24 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 51R1jOTs011438; Thu, 27 Feb 2025 01:45:24 GMT (envelope-from git) Date: Thu, 27 Feb 2025 01:45:24 GMT Message-Id: <202502270145.51R1jOTs011438@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Alexander Ziaee Subject: git: 6875767cf2e2 - stable/14 - 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/stable/14 X-Git-Reftype: branch X-Git-Commit: 6875767cf2e21b49769d5d78e2dffaaf655ca8b4 Auto-Submitted: auto-generated The branch stable/14 has been updated by ziaee: URL: https://cgit.FreeBSD.org/src/commit/?id=6875767cf2e21b49769d5d78e2dffaaf655ca8b4 commit 6875767cf2e21b49769d5d78e2dffaaf655ca8b4 Author: Alexander Ziaee AuthorDate: 2025-02-24 17:33:24 +0000 Commit: Alexander Ziaee CommitDate: 2025-02-27 01:44:37 +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 (cherry picked from commit 7c3c8605d62f5d27a5228a3787aae6e573f77d59) --- lib/libc/sys/recv.2 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/libc/sys/recv.2 b/lib/libc/sys/recv.2 index 8d50086c3eb9..8caef85db812 100644 --- a/lib/libc/sys/recv.2 +++ b/lib/libc/sys/recv.2 @@ -318,14 +318,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