Module Name: src
Committed By: riastradh
Date: Wed Sep 10 21:09:32 UTC 2014
Modified Files:
src/usr.sbin/pcictl: pcictl.8
Log Message:
Sternly advise against `pcictl read/write'. Use .Cm, not .Nm, while here.
To generate a diff of this commit:
cvs rdiff -u -r1.14 -r1.15 src/usr.sbin/pcictl/pcictl.8
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.sbin/pcictl/pcictl.8
diff -u src/usr.sbin/pcictl/pcictl.8:1.14 src/usr.sbin/pcictl/pcictl.8:1.15
--- src/usr.sbin/pcictl/pcictl.8:1.14 Mon Sep 1 07:11:19 2014
+++ src/usr.sbin/pcictl/pcictl.8 Wed Sep 10 21:09:32 2014
@@ -1,4 +1,4 @@
-.\" $NetBSD: pcictl.8,v 1.14 2014/09/01 07:11:19 manu Exp $
+.\" $NetBSD: pcictl.8,v 1.15 2014/09/10 21:09:32 riastradh Exp $
.\"
.\" Copyright 2001 Wasabi Systems, Inc.
.\" All rights reserved.
@@ -84,7 +84,7 @@ If the bus is not specified, it defaults
PCI bus specified on the command line.
If the function is not specified, it defaults to 0.
.Pp
-.Nm read
+.Cm read
.Op Fl b Ar bus
.Fl d Ar device
.Op Fl f Ar function
@@ -96,7 +96,16 @@ If the bus is not specified, it defaults
PCI bus specified on the command line.
If the function is not specified, it defaults to 0.
.Pp
-.Nm write
+.Em WARNING:
+.Nm
+.Cm read
+is a dangerous command that can damage hardware and panic the operating
+system, even though it appears to be a harmless read-only operation.
+It is meant as a diagnostic tool for experiments or to debug device
+drivers.
+Do not use it as a substitute for a device driver!
+.Pp
+.Cm write
.Op Fl b Ar bus
.Fl d Ar device
.Op Fl f Ar function
@@ -108,6 +117,15 @@ configuration register.
If the bus is not specified, it defaults to the bus number of the
PCI bus specified on the command line.
If the function is not specified, it defaults to 0.
+.Pp
+.Em WARNING:
+.Nm
+.Cm read
+is a dangerous command that can damage hardware and panic the operating
+system.
+It is meant as a diagnostic tool for experiments or to debug device
+drivers.
+Do not use it as a substitute for a device driver!
.Sh FILES
.Pa /dev/pci*
- PCI bus device nodes
