Page MenuHomeFreeBSD

gone_in(9): update man page
AcceptedPublic

Authored by mhorne on Jun 27 2025, 6:26 PM.
Tags
None
Referenced Files
Unknown Object (File)
Mon, Oct 13, 6:03 AM
Unknown Object (File)
Sat, Sep 27, 3:22 PM
Unknown Object (File)
Sep 14 2025, 12:30 AM
Unknown Object (File)
Sep 3 2025, 7:36 PM
Unknown Object (File)
Sep 3 2025, 7:33 AM
Unknown Object (File)
Sep 1 2025, 8:41 AM
Unknown Object (File)
Aug 25 2025, 9:36 AM
Unknown Object (File)
Aug 23 2025, 10:53 PM
Subscribers

Details

Reviewers
glebius
imp
emaste
Summary

Sync it with the recent tweaks to these macros:

  • Update function signatures
  • Rewrite description
  • Bump major version in EXAMPLES
Test Plan

Rendered output:

GONE_IN(9)             FreeBSD Kernel Developer's Manual            GONE_IN(9)

NAME
     gone_in, gone_in_dev – deprecation notice functions

SYNOPSIS
     #include <sys/systm.h>

     void
     gone_in(int major, const char *msg, ...);

     void
     gone_in_dev(device_t dev, int major, const char *msg, ...);

DESCRIPTION
     The 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 FreeBSD release.

     The major argument specifies the major version of the FreeBSD release
     that will remove the deprecated functionality.

     The message msg is a printf(3)-style format string.  The formatted
     message is sent to the kernel dmesg(8) log and will appear on the
     console; it should state clearly what functionality is deprecated.

     Each instance of a gone_in() deprecation notice will be printed no more
     than one time.

     The gone_in_dev() function behaves identically to gone_in(), but it
     accepts an additional dev argument that will be passed to
     device_printf(9).

EXAMPLES
           void
           sample_init(void)
           {
                   /* Initializaiton code omitted. */

                   gone_in(16, "Giant-locked filesystem");
           }

           int
           example_driver_attach(struct example_driver_softc *sc)
           {
                   /* Attach code omitted. */

                   gone_in_dev(sc->dev, 16, "Giant-locked driver");
           }

SEE ALSO
     printf(3), device_printf(9), printf(9)

HISTORY
     The gone_in functions first appeared in FreeBSD 11.

FreeBSD 15.0-CURRENT             June 27, 2025            FreeBSD 15.0-CURRENT

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 65121
Build 62004: arc lint + arc unit