From nobody Tue May 21 03:27:34 2024 X-Original-To: dev-commits-src-branches@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 4Vk0HV308yz5L27c; Tue, 21 May 2024 03:27:34 +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 "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Vk0HV2Dgdz438D; Tue, 21 May 2024 03:27:34 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1716262054; 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=Z0z/NXGoXnF+hC6kr4kpSjZ28sv9TgHaZO8L6eAjJyg=; b=NtOORRId4AiSyyokfaYY4LZ0mDiatHw9R/qtt41mxGwwDh7A1lkhe4CcgaeATjYxU7592I i22H1HOgm7NubNWOlgwY1QP1o3p/c7HDQ4aviaGRF5Ic72FkAyh4ohTBbo5xVCCi8w0vip sbPFh1h7TUhMLfOMoGBxtEqvaowtREKOhyW0GBRRDSBgxkI1OhxpOXqdXFzQ6uOo05j3s6 1puwXw6KywBpm4MWIuSBm8j/7KzPbycToTnrcioN67cTv+CEhKIMP01CFLpj4rgHYa+Hbg sUCsKNP1TMzRuqps5XPbSvneHszoh3qbUUgMLIaDZjIRCjZ8/2Iv1b3y3zZ3BQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1716262054; a=rsa-sha256; cv=none; b=rcQ5A0bzTh40SCocDb+qI05AKU7I4SloqnS5jeQ8kqdrEkoqe6kmzqRCUr3yv0STpO4JeT jwJTuW8MSJjHHCvfDHOFBdlCIadDbAmP6sC3xiR627oCW2jn3+I5kZItwgQErkJHLKP0Jj yEQ/Qa5lf1lXnFuJlvN1NxVEKBFogC/0E6yHa4ZIEopMRdhYnKxXTuTNoVVfkebrG5Ude7 QZWZ4TKIU3uQuRykGwxcvsIGo53N7uZ+w/7waRooHqAIP+6pcBJCYF1JhKb9nkbpiL1w// Y0QLPvDPABtk8wkp/VE4vWOqczEwWPeY/uhl0FHr3ldYruc1nHlRRvcFLXXLKQ== 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=1716262054; 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=Z0z/NXGoXnF+hC6kr4kpSjZ28sv9TgHaZO8L6eAjJyg=; b=JhMhD9T+HhIBjuxSK8EJ+fdV0RfIVfCz6wwLOjZwYvGxHt/zBN6i2a7/VZ49yzDlNn3x2L DiESuoiT7lS3j3F0Tiqyd/ARpRaO4pJ/GYJEmLjvMhxR04Jh6rvvctyiibiCgrpKKkFnkj 1Nb3DWSxoPpArTQA6zXH7TVUHpztOjGVsc7jMxkyeTq6qOKgTHJStqYDfNZC6jC1Fd4t0+ ZOpZLgq3vFZb7TzukztGyoX5UykIdxglkbh/EqauB5ytHbw5XWgLGIekF911gSQjaV6Wiq OrFJz1Xlvu9i1tyAdbBf7toPro6legfK0ZPyOMoFbXXf5k/oUMX26SEDzvLbOA== 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 4Vk0HV1k3Kz15Fq; Tue, 21 May 2024 03:27:34 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 44L3RYSN052557; Tue, 21 May 2024 03:27:34 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 44L3RYK7052554; Tue, 21 May 2024 03:27:34 GMT (envelope-from git) Date: Tue, 21 May 2024 03:27:34 GMT Message-Id: <202405210327.44L3RYK7052554@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Warner Losh Subject: git: e7d689faaf77 - stable/14 - sysexits: Tidy deprecated header and manual List-Id: Commits to the stable branches of the FreeBSD src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-branches List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-branches@freebsd.org Sender: owner-dev-commits-src-branches@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: imp X-Git-Repository: src X-Git-Refname: refs/heads/stable/14 X-Git-Reftype: branch X-Git-Commit: e7d689faaf77d303d2b9d050e25d8f710719be4b Auto-Submitted: auto-generated The branch stable/14 has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=e7d689faaf77d303d2b9d050e25d8f710719be4b commit e7d689faaf77d303d2b9d050e25d8f710719be4b Author: Alexander Ziaee AuthorDate: 2024-05-10 02:43:39 +0000 Commit: Warner Losh CommitDate: 2024-05-21 03:10:15 +0000 sysexits: Tidy deprecated header and manual was deprecated in the base system in a1432b4 for FreeBSD 8.0 and is retained only for backwards compatibility. Make that clear, since sysexits(3) suggested using it since it was in style(9) prior to this. MFC after: 1 week Co-authored-by: imp Fixes: a1432b4 Reviewed by: imp, pauamma (previous version) Pull Request https://github.com/freebsd/freebsd-src/pull/1195 (cherry picked from commit 5ccaab1797e5bdc404f2299ebaec1265547a4744) --- include/sysexits.h | 7 ++++--- share/man/man3/sysexits.3 | 43 ++++++++++++++++++------------------------- 2 files changed, 22 insertions(+), 28 deletions(-) diff --git a/include/sysexits.h b/include/sysexits.h index 9eef5abebe93..44449e05ff06 100644 --- a/include/sysexits.h +++ b/include/sysexits.h @@ -37,9 +37,10 @@ /* * SYSEXITS.H -- Exit status codes for system programs. * - * This include file attempts to categorize possible error - * exit statuses for system programs, notably delivermail - * and the Berkeley network. + * This include file attempts to categorize error exit statuses + * for system programs, notably sendmail. These values exist only + * for interface compatibility, and are deprecated for FreeBSD + * base software. * * Error numbers begin at EX__BASE to reduce the possibility of * clashing with other exit statuses that random programs may diff --git a/share/man/man3/sysexits.3 b/share/man/man3/sysexits.3 index ef736192e439..62f79b286a16 100644 --- a/share/man/man3/sysexits.3 +++ b/share/man/man3/sysexits.3 @@ -1,7 +1,7 @@ +.\"- +.\" SPDX-License-Identifier: BSD-2-Clause .\" -.\" Copyright (c) 1996 Joerg Wunsch -.\" -.\" All rights reserved. +.\" Copyright (c) 1996 Joerg Wunsch. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -23,27 +23,20 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" " -.Dd January 21, 2010 +.Dd May 9, 2024 .Dt SYSEXITS 3 .Os .Sh NAME .Nm sysexits -.Nd preferable exit codes for programs +.Nd legacy exit status codes for system programs .Sh SYNOPSIS .In sysexits.h .Sh DESCRIPTION -According to -.Xr style 9 , -it is not a good practice to call -.Xr exit 3 -with arbitrary values to indicate a failure condition when ending -a program. -Instead, the pre-defined exit codes from -.Nm -should be used, so the caller of the process can get a rough -estimation about the failure class without looking up the source code. -.Pp +Some commands attempt to describe the nature of a failure condition +by using these pre-defined exit codes. +This interface has been deprecated and is retained only for compatibility. +Its use is discouraged. +.Sh ERRORS The successful exit is always indicated by a status of 0, or .Sy EX_OK . Error numbers begin at @@ -112,8 +105,7 @@ The remote system returned something that was during a protocol exchange. .It Sy EX_NOPERM Pq 77 You did not have sufficient permission to perform the operation. -This -is not intended for file system problems, which should use +This is not intended for file system problems, which should use .Sy EX_NOINPUT or .Sy EX_CANTCREAT , @@ -131,12 +123,13 @@ parenthesis for easy reference. .Sh HISTORY The .Nm -file appeared somewhere after -.Bx 4.3 . +file first appeared in +.Bx 4 . .Sh AUTHORS This manual page was written by -.An J\(:org Wunsch -after the comments in -.In sysexits.h . +.An J\(:org Wunsch . .Sh BUGS -The choice of an appropriate exit value is often ambiguous. +.Bl -tag -width 0 -compact +.It This interface is not portable. +.It The choice of an appropriate exit value is often ambiguous. +.El