From nobody Mon Oct 27 18:51:32 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 4cwMzn220Fz6FKdD; Mon, 27 Oct 2025 18:51:33 +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 "R12" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4cwMzn0FRmz3Hn0; Mon, 27 Oct 2025 18:51:33 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1761591093; 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=0cIdmbQkkYVcf5lqAut6iKgtKhi6yjSW8YA/PRpbiDo=; b=quVkH/I8RoDNIvNjLyiJxkrrEOcMOIQOjcQjyg4sB9UgZR9kWwzO5i2dprEkDU8bvnf7yu owq2zu2h7TZgVFNVk3S2Dpz4k1I96ZF3H5nAcqyQ+XYN5Qp2Nx4XOCAygjlcl9rfnD8d0X r0emV3UCtc5pC89HlZGHhSkfLrDfRAF99KRdAg6IOYZwzjd2Z15h2HzDU0sWEuTIiRP+wb /s1Yl68uR/BgvarErumLCZVreocKLDVIApJXe6HOWyH+CFDijdeYWToFg5rtEyJxxDa+Sz iY8ffVllgOz+8TD6PbNzG/JfE3iB31qDpmJvlLqldl6Xp+xxZ49v4SzsFHzNVw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1761591093; 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=0cIdmbQkkYVcf5lqAut6iKgtKhi6yjSW8YA/PRpbiDo=; b=E2bd6sxcovJ2dNfzTZsFA9/1kjf7I3+BpIYC/8ir2Kb8fOneiGXFHtzX88yX/oPhzbaMNU t7CozquyYsjnONXA/yG2REtmnpFk1creYRZm4MKemKUx5zoPD5wzGxuPv4hnajX407ULfH xxRfWdoR7vYWEV5RrcdaqpksQImQfGXsUYPrJwjDjspc1T78exjAjgOOzhT99e/OymR625 sBujJc8In24TejpbEyEX1m3CAwlsXy2nEVxZYIuTsEMN8bhuIoE6IyzxZOXB3RHbmKtzrR kYPrCr7GNp5/zom2MAk728LOeL1EGGejUwWJqQLo89lY7HE5xT2OHJcYYhqTCw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1761591093; a=rsa-sha256; cv=none; b=HqG3KT9KsstJ7NAyM+co9HS8kUPvGmu/7oIoTO89Jdmi6BD+S6sXFFu0N37cFpo2DE4lrf x7K3on2dOmyRtPRkNabOByg7OGO8oNymMGzM/Zxv8XGEVmuLM6kYtXQpgLPi50m5PelPGt GqcLxHM75fqvyxlhtcHu74qlVNUYbYIV6HDmtHPXCuPxnHGEpoLoGVCqomNwOM2fo3b7TF yERHV/0pRfgyx7g6PRyb0GZiZ4Yj8Ardv8X/y3/YyFzdqoEfBnj0rGsgvydByJpvo0uVio mM2ofFJoScYXLZOFuWwNGgpo7v9c9NW84BDg4lHpyie2QtTKDsWYEZCRCNatnA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none 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 4cwMzm53Spz13d; Mon, 27 Oct 2025 18:51:32 +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 59RIpWF5076385; Mon, 27 Oct 2025 18:51:32 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 59RIpWWJ076382; Mon, 27 Oct 2025 18:51:32 GMT (envelope-from git) Date: Mon, 27 Oct 2025 18:51:32 GMT Message-Id: <202510271851.59RIpWWJ076382@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Gleb Smirnoff Subject: git: 3bcd7d4fa46a - main - gone_in(9): bring the manual page up to date 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: glebius X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 3bcd7d4fa46a29ec3576d9474e9541510885cfaf Auto-Submitted: auto-generated The branch main has been updated by glebius: URL: https://cgit.FreeBSD.org/src/commit/?id=3bcd7d4fa46a29ec3576d9474e9541510885cfaf commit 3bcd7d4fa46a29ec3576d9474e9541510885cfaf Author: Gleb Smirnoff AuthorDate: 2025-10-27 18:51:04 +0000 Commit: Gleb Smirnoff CommitDate: 2025-10-27 18:51:04 +0000 gone_in(9): bring the manual page up to date Fixes: 01addd846c64fc2c8be610d83bfdc84ddb57f2ec --- share/man/man9/gone_in.9 | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/share/man/man9/gone_in.9 b/share/man/man9/gone_in.9 index ebdc1ab19bfa..1b60e1eb10c2 100644 --- a/share/man/man9/gone_in.9 +++ b/share/man/man9/gone_in.9 @@ -23,7 +23,7 @@ .\" (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 August 16, 2021 +.Dd June 24, 2025 .Dt GONE_IN 9 .Os .Sh NAME @@ -33,14 +33,15 @@ .Sh SYNOPSIS .In sys/systm.h .Ft void -.Fn gone_in "int major" "const char *msg" +.Fn gone_in "int major" "const char *msg" "..." .Ft void -.Fn gone_in_dev "device_t dev" "int major" "const char *msg" +.Fn gone_in_dev "device_t dev" "int major" "const char *msg" "..." .Sh DESCRIPTION The -.Fn gone_in -functions are used to provide a notice that the kernel is using a driver or -some other functionality that is deprecated, and will be removed in a future +.Nm gone_in +functions are used to provide a notice that the kernel is actively using a +driver or some other functionality that is deprecated, and is planned for +removal in a future .Fx release. The notice is sent to the kernel @@ -51,30 +52,29 @@ The argument specifies the major version of the .Fx release that will remove the deprecated functionality. +The notice shall be printed only once, thus +.Nm +functions are safe to use in often executed code paths. +.Pp +.Nm gone_in_dev +will prepend driver name before the notice. .Pp In releases before .Fa major -the deprecation notice states -.Do -Deprecated code (to be removed in FreeBSD -.Fa major Ns ): -.Fa msg -.Dc . -In releases equal to and after -.Fa major -the notice states +the provided notice will be appended with .Do -Obsolete code will be removed soon: -.Fa msg +To be removed in FreeBSD +.Fa major Ns .Dc . .Sh EXAMPLES .Bd -literal -offset indent void -sample_init(void) +example_api(foo_t *args) { - /* Initialization code omitted. */ + gone_in(16, "Warning! %s[%u] uses obsolete API. ", + curthread->td_proc->p_comm, curthread->td_proc->p_pid); - gone_in(14, "Giant-locked filesystem"); + /* API implementation omitted. */ } int @@ -82,7 +82,7 @@ example_driver_attach(struct example_driver_softc *sc) { /* Attach code omitted. */ - gone_in_dev(sc->dev, 14, "Giant-locked driver"); + gone_in_dev(sc->dev, 16, "driver is deprecated"); } .Ed .Sh HISTORY