freebsd-nq/share/man/man9/BUS_PRINT_CHILD.9

.\" -*- nroff -*-
.\"
.\" Copyright (c) 1998 Doug Rabson
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" 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 DEVELOPERS ``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 DEVELOPERS 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 January 6, 2005
.Dt BUS_PRINT_CHILD 9
.Os
.Sh NAME
.Nm BUS_PRINT_CHILD
.Nd print information about a device
.Sh SYNOPSIS
.In sys/param.h
.In sys/bus.h
.Ft int
.Fn BUS_PRINT_CHILD "device_t dev" "device_t child"
.Sh DESCRIPTION
The
.Fn BUS_PRINT_CHILD
method
is called from system code which prints out a description of a
device.
It should describe the attachment that the child has with
the parent.
For instance the TurboLaser bus prints which node the
device is attached to.
Please see
.Xr bus_generic_print_child 9
for more information regarding the proper formatting of the messages
printed by
.Fn BUS_PRINT_CHILD .
.Sh RETURN VALUES
The number of characters output.
.Sh SEE ALSO
.Xr device 9 ,
.Xr driver 9
.Sh AUTHORS
This manual page was written by
.An Doug Rabson .
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.\" -- nroff --`
			`.\"`
			`.\" Copyright (c) 1998 Doug Rabson`
			`.\"`
			`.\" All rights reserved.`
			`.\"`
			`.\" This program is free software.`
			`.\"`
			`.\" 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 DEVELOPERS ``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 DEVELOPERS 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.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.\"`
Use .Fn function_name. MFC after: 3 days 2005-01-06 17:11:56 +00:00			`.Dd January 6, 2005`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.Dt BUS_PRINT_CHILD 9`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.Sh NAME`
			`.Nm BUS_PRINT_CHILD`
			`.Nd print information about a device`
			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/param.h`
			`.In sys/bus.h`
Alter the behavior of sys/kern/subr_bus.c:device_print_child() - device_print_child() either lets the BUS_PRINT_CHILD method produce the entire device announcement message or it prints "foo0: not found\n" Alter sys/kern/subr_bus.c:bus_generic_print_child() to take on the previous behavior of device_print_child() (printing the "foo0: <FooDevice 1.1>" bit of the announce message.) Provide bus_print_child_header() and bus_print_child_footer() to actually print the output for bus_generic_print_child(). These functions should be used whenever possible (unless you can just use bus_generic_print_child()) The BUS_PRINT_CHILD method now returns int instead of void. Modify everything else that defines or uses a BUS_PRINT_CHILD method to comply with the above changes. - Devices are 'on' a bus, not 'at' it. - If a custom BUS_PRINT_CHILD method does the same thing as bus_generic_print_child(), use bus_generic_print_child() - Use device_get_nameunit() instead of both device_get_name() and device_get_unit() - All BUS_PRINT_CHILD methods return the number of characters output. Reviewed by: dfr, peter 1999-07-29 01:03:04 +00:00			`.Ft int`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.Fn BUS_PRINT_CHILD "device_t dev" "device_t child"`
			`.Sh DESCRIPTION`
Use .Fn function_name. MFC after: 3 days 2005-01-06 17:11:56 +00:00			`The`
			`.Fn BUS_PRINT_CHILD`
			`method`
			`is called from system code which prints out a description of a`
Mdoc Janitor: * Fix hard sentence breaks. * Correct use of a period in DELAY(9). 2003-10-23 01:31:25 +00:00			`device.`
			`It should describe the attachment that the child has with`
			`the parent.`
			`For instance the TurboLaser bus prints which node the`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`device is attached to.`
Replace a manual.section file reference with a proper mdoc(7) .Xr reference. PR: 18625 Submitted by: Alexander Langer <alex@cichlids.com> 2000-05-18 00:20:55 +00:00			`Please see`
			`.Xr bus_generic_print_child 9`
			`for more information regarding the proper formatting of the messages`
Use .Fn function_name. MFC after: 3 days 2005-01-06 17:11:56 +00:00			`printed by`
			`.Fn BUS_PRINT_CHILD .`
Sort sections. 2005-01-21 08:36:40 +00:00			`.Sh RETURN VALUES`
			`The number of characters output.`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.Sh SEE ALSO`
			`.Xr device 9 ,`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`.Xr driver 9`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.Sh AUTHORS`
Mdoc Janitor: * Use 'manual' instead of 'man' for consistency. 2003-10-23 06:24:55 +00:00			`This manual page was written by`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.An Doug Rabson .`