jimzah/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src.git synced 2024-12-04 05:58:57 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Add gone_in(9) man page

Browse Source 
Reviewed by:	imp
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D30703
This commit is contained in:
Ed Maste 2021-06-09 13:19:16 -04:00
parent 14a4d6d013
commit d8aeab4b45
2 changed files with 96 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
share/man/man9/Makefile
View File

@ -161,6 +161,7 @@ MAN= accept_filter.9 \
g_provider_by_name.9 \
groupmember.9 \
g_wither_geom.9 \
gone_in.9 \
hardclock.9 \
hash.9 \
hashinit.9 \
@ -1119,6 +1120,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 \

94
share/man/man9/gone_in.9 Normal file
View File

@ -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 .