[src/trunk]: src/usr.sbin/pcictl Sternly advise against `pcictl read/write'. ...

[riastradh <riastradh%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/628cf3b64a3f
branches:  trunk
changeset: 332193:628cf3b64a3f
user:      riastradh <riastradh%NetBSD.org@localhost>
date:      Wed Sep 10 21:09:32 2014 +0000

description:
Sternly advise against `pcictl read/write'.  Use .Cm, not .Nm, while here.

diffstat:

 usr.sbin/pcictl/pcictl.8 |  24 +++++++++++++++++++++---
 1 files changed, 21 insertions(+), 3 deletions(-)

diffs (52 lines):

diff -r 98f84d4c7cdf -r 628cf3b64a3f usr.sbin/pcictl/pcictl.8
--- a/usr.sbin/pcictl/pcictl.8  Wed Sep 10 21:04:08 2014 +0000
+++ b/usr.sbin/pcictl/pcictl.8  Wed Sep 10 21:09:32 2014 +0000
@@ -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 @@
 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 @@
 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 @@
 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