git: 4276dfa8c4b9 - main - BUS_HINTED_CHILD.9: New manpage to document this bus method

From: John Baldwin <jhb_at_FreeBSD.org>
Date: Thu, 16 Jan 2025 15:52:00 UTC
The branch main has been updated by jhb:

URL: https://cgit.FreeBSD.org/src/commit/?id=4276dfa8c4b9e75ab29f2c53a7af36c2f77ab563

commit 4276dfa8c4b9e75ab29f2c53a7af36c2f77ab563
Author:     John Baldwin <jhb@FreeBSD.org>
AuthorDate: 2025-01-16 15:51:44 +0000
Commit:     John Baldwin <jhb@FreeBSD.org>
CommitDate: 2025-01-16 15:51:44 +0000

    BUS_HINTED_CHILD.9: New manpage to document this bus method
    
    Reviewed by:    ziaee, imp
    Differential Revision:  https://reviews.freebsd.org/D48366
---
 share/man/man9/BUS_HINTED_CHILD.9 | 36 ++++++++++++++++++++++++++++++++++++
 share/man/man9/Makefile           |  1 +
 2 files changed, 37 insertions(+)

diff --git a/share/man/man9/BUS_HINTED_CHILD.9 b/share/man/man9/BUS_HINTED_CHILD.9
new file mode 100644
index 000000000000..699bb06e8dd8
--- /dev/null
+++ b/share/man/man9/BUS_HINTED_CHILD.9
@@ -0,0 +1,36 @@
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
+.\" Copyright (c) 2025 John Baldwin <jhb@FreeBSD.org>
+.Dd January 6, 2025
+.Dt BUS_HINTED_CHILD 9
+.Os
+.Sh NAME
+.Nm BUS_HINTED_CHILD
+.Nd notify a bus device about a potential child device identified by hints
+.Sh SYNOPSIS
+.In sys/param.h
+.In sys/bus.h
+.Ft void
+.Fn BUS_HINTED_CHILD "device_t dev" "const char *dname" "int dunit"
+.Sh DESCRIPTION
+The
+.Fn BUS_HINTED_CHILD
+method is invoked by the
+.Xr bus_enumerate_hinted_children 9
+function for each set of named hints whose
+.Dq at
+hint matches the bus device
+.Fa dev .
+Typically, this method should determine if the set of hints for the given
+device name and unit sufficiently describe a new device.
+If so, a new device should be added via
+.Xr BUS_ADD_CHILD 9 .
+.Sh SEE ALSO
+.Xr BUS_ADD_CHILD 9 ,
+.Xr device 9
+.Sh HISTORY
+The
+.Fn BUS_HINTED_CHILD
+method first appeared in
+.Fx 6.2 .
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index c09d3aa554a1..6e8edc3f698d 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -47,6 +47,7 @@ MAN=	accept_filter.9 \
 	BUS_GET_CPUS.9 \
 	BUS_GET_PROPERTY.9 \
 	bus_get_resource.9 \
+	BUS_HINTED_CHILD.9 \
 	bus_map_resource.9 \
 	BUS_NEW_PASS.9 \
 	BUS_PRINT_CHILD.9 \