From nobody Fri Dec 03 16:48:15 2021 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 2BE8318B4F5D; Fri, 3 Dec 2021 16:48:16 +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 4J5Jfl54vYz4YYL; Fri, 3 Dec 2021 16:48:15 +0000 (UTC) (envelope-from git@FreeBSD.org) 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 7412C14465; Fri, 3 Dec 2021 16:48:15 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 1B3GmFXN030558; Fri, 3 Dec 2021 16:48:15 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 1B3GmFYg030557; Fri, 3 Dec 2021 16:48:15 GMT (envelope-from git) Date: Fri, 3 Dec 2021 16:48:15 GMT Message-Id: <202112031648.1B3GmFYg030557@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Ed Maste Subject: git: 1bacdee058ae - stable/13 - Add gone_in(9) man page 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: Sender: owner-dev-commits-src-branches@freebsd.org X-BeenThere: dev-commits-src-branches@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: emaste X-Git-Repository: src X-Git-Refname: refs/heads/stable/13 X-Git-Reftype: branch X-Git-Commit: 1bacdee058ae2767e9fba5ae7593ce1518554391 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1638550095; 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=PbEwaB7H7KMGhSjcUI9mu0SkCts4Fk06A/SKWNhwuC0=; b=JpkS69g8FmAn/IxwoTtKaHwqOSAfqmDaRZTLaCCKU3lRwJorm8RRYLzgFRl++MWOG4RxnP 40VTqTeu/0RLvccDsIKRYk8ZNWIiJOJE12erqkefqF28ptd0tNUqZ3NPW4bsLsRxMcuhlp 9xEg2BQxrxmQGGFf1IB0OGjUwR/dgzIo4U57+2Hd+T67TugtfCh8OQD8ZpHrWNXD+ZAWsH Rhs91bQdMd2F1GpaHyv3N5ASQC1Xdj0SoJy1AD8TYBgG5RNovRsVdHnYmRM8ISOCWH6BNq 7isLMRsnt+FSiwQD6yrPPxahubQSAm7kKU9968FAU7NjjKdoqNmn497CfpwMRg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1638550095; a=rsa-sha256; cv=none; b=GGcL6BpYDKprnjxpm7eI8ULyYbYl1C5C2J82demVc+NBOlNu0nVCeAM56pz4mCHU0d1XKg glDGpnz7ukVUFFO82J0aDKXqMdM/bGoZir7ConjrPNdj/vrL3YQW4ejfdLJHiO4/m+IJMm rWG26WEHL46+tp9dBvB9SmP9qp+k7GCIIT3K0Ij3nqdDXRscOLnl19X3SgOWwj135jX3kF Gn9pHXiNKmy/AjtoKaDXjTwiCYAo2WuKWw1fYpwm4tjPg9jV8W9ZV5ka21VH9DBJm4W7r9 siWOMNMtgF5PixIeAAtD6pK1ihgY2I9S1PXzyxvR/PojE3lL6zGsJcCG4iBPBQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch stable/13 has been updated by emaste: URL: https://cgit.FreeBSD.org/src/commit/?id=1bacdee058ae2767e9fba5ae7593ce1518554391 commit 1bacdee058ae2767e9fba5ae7593ce1518554391 Author: Ed Maste AuthorDate: 2021-06-09 17:19:16 +0000 Commit: Ed Maste CommitDate: 2021-12-03 16:45:59 +0000 Add gone_in(9) man page Reviewed by: imp MFC after: 1 week Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D30703 (cherry picked from commit d8aeab4b45a94b3e1ab4396235e4426747e310fe) --- share/man/man9/Makefile | 2 ++ share/man/man9/gone_in.9 | 94 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+) diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index f6eced940295..73ebdef29180 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -159,6 +159,7 @@ MAN= accept_filter.9 \ g_provider_by_name.9 \ groupmember.9 \ g_wither_geom.9 \ + gone_in.9 \ hash.9 \ hashinit.9 \ hexdump.9 \ @@ -1123,6 +1124,7 @@ MLINKS+=g_geom.9 g_destroy_geom.9 \ MLINKS+=g_provider.9 g_destroy_provider.9 \ g_provider.9 g_error_provider.9 \ g_provider.9 g_new_providerf.9 +MLINKS+=gone_in.9 gone_in_dev.9 MLINKS+=hash.9 hash32.9 \ hash.9 hash32_buf.9 \ hash.9 hash32_str.9 \ diff --git a/share/man/man9/gone_in.9 b/share/man/man9/gone_in.9 new file mode 100644 index 000000000000..b2474d610b24 --- /dev/null +++ b/share/man/man9/gone_in.9 @@ -0,0 +1,94 @@ +.\" Copyright (c) 2021 The FreeBSD Foundation +.\" +.\" This document was written by Ed Maste under sponsorhip from +.\" The FreeBSD Foundation. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd August 16, 2021 +.Dt GONE_IN 9 +.Os +.Sh NAME +.Nm gone_in , +.Nm gone_in_dev +.Nd deprecation notice functions +.Sh SYNOPSIS +.In sys/systm.h +.Ft void +.Fn gone_in "int major" "const char *msg" +.Ft void +.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 +.Fx +release. +The notice is sent to the kernel +.Xr dmesg 8 +log and will appear on the console. +The +.Fa major +argument specifies the major version of the +.Fx +release that will remove the deprecated functionality. +.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 +.Do +Obsolete code will be removed soon: +.Fa msg +.Dc . +.Sh EXAMPLES +.Bd -literal -offset indent +void +sample_init(void) +{ + /* Initializaiton code omitted. */ + + gone_in(14, "Giant-locked filesystem"); +} + +int +example_driver_attach(struct example_driver_softc *sc) +{ + /* Attach code omitted. */ + + gone_in_dev(sc->dev, 14, "Giant-locked driver"); +} +.Ed +.Sh HISTORY +The +.Nm +functions first appeared in +.Fx 11 .