diff --git a/share/man/man9/gone_in.9 b/share/man/man9/gone_in.9 --- 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 27, 2025 .Dt GONE_IN 9 .Os .Sh NAME @@ -33,9 +33,9 @@ .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 @@ -43,30 +43,35 @@ 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. +.Pp 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: +The message .Fa msg -.Dc . +is a +.Xr printf 3 Ns +-style format string. +The formatted message is sent to the kernel +.Xr dmesg 8 +log and will appear on the console; +it should state clearly what functionality is deprecated. +.Pp +Each instance of a +.Fn gone_in +deprecation notice will be printed no more than one time. +.Pp +The +.Fn gone_in_dev +function behaves identically to +.Fn gone_in , +but it accepts an additional +.Fa dev +argument that will be passed to +.Xr device_printf 9 . .Sh EXAMPLES .Bd -literal -offset indent void @@ -74,7 +79,7 @@ { /* Initializaiton code omitted. */ - gone_in(14, "Giant-locked filesystem"); + gone_in(16, "Giant-locked filesystem"); } int @@ -82,9 +87,13 @@ { /* Attach code omitted. */ - gone_in_dev(sc->dev, 14, "Giant-locked driver"); + gone_in_dev(sc->dev, 16, "Giant-locked driver"); } .Ed +.Sh SEE ALSO +.Xr printf 3 , +.Xr device_printf 9 , +.Xr printf 9 .Sh HISTORY The .Nm