Differential D30703 Diff 90644 share/man/man9/gone_in.9

Changeset View

Standalone View

View Options

share/man/man9/gone_in.9

This file was added.

.\"

.\" 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 June 9, 2021

.Dt GONE_IN 9

.Os

.Sh NAME

.Nm gone_in ,

.Nm gone_in_dev

.Nd deprication notice functions

.Sh SYNOPSIS

.In sys/systm.h

.Ft void

.Fn gone_in "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

.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 FreeBSD release that will remove

the deprecated functionality.

debdrupUnsubmitted

Done

.Fa major

- argument specifies the major version of the FreeBSD release that will remove

+ argument specifies the major version of the

+ .Fx

+ release that will remove

the deprecated functionality.

debdrup:

.Pp

In releases before

.Fa major

the deprecation notice states

.Do

Deprecated code (to be removed in FreeBSD

.Fa major ):

debdrupUnsubmitted

Not Done

the deprecation notice states

.Do

- Deprecated code (to be removed in FreeBSD

+ Deprecated code (to be removed in

+ .Fx

.Fa major ):

debdrup:

emasteAuthorUnsubmitted

Done

I think this one probably should not change because it's literal console output.

emaste: I think this one probably should not change because it's literal console output.

.Fa msg

.Dc .

emasteAuthorUnsubmitted

Done

Added Ns here

emaste: Added Ns here

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

sample_init(void)

{

/* Initializaiton code omitted. */

gone_in(14, "11.x ABI compatibility");

impUnsubmitted

Not Done

11.x ABI compat isn't the headlining reason to retire, necessarily.
In the past this has been more like "Giant locked filesystem" or "Driver not migrated from old API" or simiar

imp: 11.x ABI compat isn't the headlining reason to retire, necessarily. In the past this has been…

emasteAuthorUnsubmitted

Done

This was copied from an in-tree one, but indeed "Giant locked filesystem" is probably a good canonical example

emaste: This was copied from an in-tree one, but indeed "Giant locked filesystem" is probably a good…

}

example_driver_attach(struct example_driver_softc *sc)

impUnsubmitted

Done

int

imp: int

{

/* Attach code omitted. */

gone_in_dev(sc->dev, 14, "example drivers");

impUnsubmitted

Not Done

This message needs to be more along the lines of "This hardware no longer relevant to FreeBSD" or "This wifi driver doesn't support FooBar crypto" or some other minimum bar.

imp: This message needs to be more along the lines of "This hardware no longer relevant to FreeBSD"…

emasteAuthorUnsubmitted

Done

Here's some examples from the tree, as they'd appear in dmesg:

Deprecated code (to be removed in FreeBSD 13): pccard removed, an doesn't support modern crypto
Deprecated code (to be removed in FreeBSD 13): pccard removed, an doesn't support modern crypto
Deprecated code (to be removed in FreeBSD 13): amr(4) driver
Deprecated code (to be removed in FreeBSD 13): FreeBSD 11.x ABI compat
Deprecated code (to be removed in FreeBSD 14): FreeBSD 12.x ABI compat
Deprecated code (to be removed in FreeBSD 13): drm2 drivers
Deprecated code (to be removed in FreeBSD 14): esp(4) driver
Deprecated code (to be removed in FreeBSD 14): PC Card to be removed
Deprecated code (to be removed in FreeBSD 14): mly(4) removed
prefixed with the device name/number for gone_in_dev of course

IMO something short like "ISA drivers", "obsolete hardware" etc. is what we should suggest

sys/dev/mly/mly.c
339: gone_in_dev(dev, 13, "");

sys/dev/twa/tw_osl_freebsd.c
416: gone_in_dev(dev, 13, "twa(4) removed");

sys/dev/iir/iir_pci.c
339: gone_in_dev(dev, 13, "iir(4) removed");

emaste: Here's some examples from the tree, as they'd appear in dmesg: Deprecated code (to be removed…

}

.Ed

.Sh HISTORY

The

.Nm

functions first appeared in

.Fx ?

impUnsubmitted

Done

imp: 11