Module Name: src Committed By: dyoung Date: Thu May 14 23:05:21 UTC 2009
Modified Files: src/share/man/man9: pmf.9 Log Message: Improve pmf_device_register(9) and pmf_device_register1(9) descriptions. To generate a diff of this commit: cvs rdiff -u -r1.10 -r1.11 src/share/man/man9/pmf.9 Please note that diffs are not public domain; they are subject to the copyright notices on the relevant files.
Modified files: Index: src/share/man/man9/pmf.9 diff -u src/share/man/man9/pmf.9:1.10 src/share/man/man9/pmf.9:1.11 --- src/share/man/man9/pmf.9:1.10 Thu May 14 21:27:55 2009 +++ src/share/man/man9/pmf.9 Thu May 14 23:05:21 2009 @@ -1,4 +1,4 @@ -.\" $NetBSD: pmf.9,v 1.10 2009/05/14 21:27:55 jnemeth Exp $ +.\" $NetBSD: pmf.9,v 1.11 2009/05/14 23:05:21 dyoung Exp $ .\" .\" Copyright (c) 2007 Jared D. McNeill <jmcne...@invisible.ca> .\" All rights reserved. @@ -140,6 +140,16 @@ .Bl -tag -width compact .It Fn pmf_device_register "dev" "suspend" "resume" Register a device with the power management framework. +.Fa suspend +and +.Fa resume +are passed +.Fa dev +and they return +.Dv true +on success and +.Dv false +on failure. If either .Fa suspend or @@ -153,7 +163,25 @@ .Dv false if there was an error. .It Fn pmf_device_register1 "dev" "suspend" "resume" "shutdown" -Like pmf_device_register, but additionally registers a shutdown handler. +Like +.Fn pmf_device_register , +but additionally registers a shutdown handler. +During system shutdown, +.Fn pmf_system_shutdown +calls +.Fa shutdown +on +.Fa dev +with the +.Xr reboot 2 +.Dq howto +in the second argument. +.Fa shutdown +should return +.Dv true +on success and +.Dv false +on failure. .It Fn pmf_device_deregister "dev" Deregister a device with the power management framework. .It Fn pmf_device_suspend "dev"