1.\" Copyright (c) 2021 The FreeBSD Foundation 2.\" 3.\" This document was written by Ed Maste under sponsorhip from 4.\" The FreeBSD Foundation. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25.\" 26.\" $FreeBSD$ 27.\" 28.Dd August 16, 2021 29.Dt GONE_IN 9 30.Os 31.Sh NAME 32.Nm gone_in , 33.Nm gone_in_dev 34.Nd deprecation notice functions 35.Sh SYNOPSIS 36.In sys/systm.h 37.Ft void 38.Fn gone_in "int major" "const char *msg" 39.Ft void 40.Fn gone_in_dev "device_t dev" "int major" "const char *msg" 41.Sh DESCRIPTION 42The 43.Fn gone_in 44functions are used to provide a notice that the kernel is using a driver or 45some other functionality that is deprecated, and will be removed in a future 46.Fx 47release. 48The notice is sent to the kernel 49.Xr dmesg 8 50log and will appear on the console. 51The 52.Fa major 53argument specifies the major version of the 54.Fx 55release that will remove the deprecated functionality. 56.Pp 57In releases before 58.Fa major 59the deprecation notice states 60.Do 61Deprecated code (to be removed in FreeBSD 62.Fa major Ns ): 63.Fa msg 64.Dc . 65In releases equal to and after 66.Fa major 67the notice states 68.Do 69Obsolete code will be removed soon: 70.Fa msg 71.Dc . 72.Sh EXAMPLES 73.Bd -literal -offset indent 74void 75sample_init(void) 76{ 77 /* Initializaiton code omitted. */ 78 79 gone_in(14, "Giant-locked filesystem"); 80} 81 82int 83example_driver_attach(struct example_driver_softc *sc) 84{ 85 /* Attach code omitted. */ 86 87 gone_in_dev(sc->dev, 14, "Giant-locked driver"); 88} 89.Ed 90.Sh HISTORY 91The 92.Nm 93functions first appeared in 94.Fx 11 . 95