Skip to content

Commit 4276dfa

Browse files
committed
BUS_HINTED_CHILD.9: New manpage to document this bus method
Reviewed by: ziaee, imp Differential Revision: https://reviews.freebsd.org/D48366
1 parent 491db92 commit 4276dfa

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

share/man/man9/BUS_HINTED_CHILD.9

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.\"
2+
.\" SPDX-License-Identifier: BSD-2-Clause
3+
.\"
4+
.\" Copyright (c) 2025 John Baldwin <[email protected]>
5+
.Dd January 6, 2025
6+
.Dt BUS_HINTED_CHILD 9
7+
.Os
8+
.Sh NAME
9+
.Nm BUS_HINTED_CHILD
10+
.Nd notify a bus device about a potential child device identified by hints
11+
.Sh SYNOPSIS
12+
.In sys/param.h
13+
.In sys/bus.h
14+
.Ft void
15+
.Fn BUS_HINTED_CHILD "device_t dev" "const char *dname" "int dunit"
16+
.Sh DESCRIPTION
17+
The
18+
.Fn BUS_HINTED_CHILD
19+
method is invoked by the
20+
.Xr bus_enumerate_hinted_children 9
21+
function for each set of named hints whose
22+
.Dq at
23+
hint matches the bus device
24+
.Fa dev .
25+
Typically, this method should determine if the set of hints for the given
26+
device name and unit sufficiently describe a new device.
27+
If so, a new device should be added via
28+
.Xr BUS_ADD_CHILD 9 .
29+
.Sh SEE ALSO
30+
.Xr BUS_ADD_CHILD 9 ,
31+
.Xr device 9
32+
.Sh HISTORY
33+
The
34+
.Fn BUS_HINTED_CHILD
35+
method first appeared in
36+
.Fx 6.2 .

share/man/man9/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ MAN= accept_filter.9 \
4747
BUS_GET_CPUS.9 \
4848
BUS_GET_PROPERTY.9 \
4949
bus_get_resource.9 \
50+
BUS_HINTED_CHILD.9 \
5051
bus_map_resource.9 \
5152
BUS_NEW_PASS.9 \
5253
BUS_PRINT_CHILD.9 \

0 commit comments

Comments
 (0)