Bug 133186

Summary:	[patch] powerd(8) man page errors
Product:	Documentation	Reporter:	Warren Block <wblock>
Component:	Books & Articles	Assignee:	Gavin Atkinson <gavin>
Status:	Closed FIXED
Severity:	Affects Only Me
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description Warren Block 2009-03-29 18:50:01 UTC

powerd man page needs to be updated and clarified:

1. "It offers three modes (maximum, minimum, and adaptive) that can be individually selected while on AC power or batter-ies.  The modes maximum, minimum, adaptive and hiadaptive may be abbrevi-ated max, min, adp, hadp."

That's actually four modes.  hiadaptive should be mentioned in the first sentence, too.


2.  "Hiadaptive mode is alike adaptive mode,"

Change "alike" to "like".


3.  "It rises frequency faster, drops slower and keeps twice lower CPU load."

"rises" should be "increases".

"keeps twice lower CPU load" is extremely unclear.  Is this load being put on the CPU by powerd?  Or is it CPU load being monitored by powerd?  Lower than what?  What does "twice lower" mean?

Fix: 

1.  Fix mode count and list in second sentence: "It offers three modes (maximum, minimum, and adaptive)" should be "It offers four modes (maximum, minimum, adaptive, and hiadaptive)"

2.  Change "alike" to "like".

3.  Rewrite the sentence that explains what hiadaptive does so that it is clear and unambiguous.
How-To-Repeat: man 8 powerd

Comment 1 Gavin Atkinson freebsd_committer

2009-08-12 15:54:33 UTC

Patch at http://people.freebsd.org/~gavin/PRs/133186.diff

Comment 2 dfilter service freebsd_committer

2009-12-21 22:56:20 UTC

Author: gavin
Date: Mon Dec 21 22:56:06 2009
New Revision: 200819
URL: http://svn.freebsd.org/changeset/base/200819

Log:
  Grammar and minor tweaks to powerd(8) man page.
  
  PR:		docs/133186
  Approved by:	ed (mentor)
  MFC after:	2 weeks

Modified:
  head/usr.sbin/powerd/powerd.8

Modified: head/usr.sbin/powerd/powerd.8
==============================================================================
--- head/usr.sbin/powerd/powerd.8	Mon Dec 21 22:16:07 2009	(r200818)
+++ head/usr.sbin/powerd/powerd.8	Mon Dec 21 22:56:06 2009	(r200819)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd December 24, 2008
+.Dd December 21, 2009
 .Dt POWERD 8
 .Os
 .Sh NAME
@@ -45,7 +45,7 @@ The
 .Nm
 utility monitors the system state and sets various power control options
 accordingly.
-It offers three modes (maximum, minimum, and adaptive) that can be
+It offers four modes (maximum, minimum, adaptive and hiadaptive) that can be
 individually selected while on AC power or batteries.
 The modes maximum, minimum, adaptive and hiadaptive may be abbreviated
 max, min, adp, hadp.
@@ -57,9 +57,10 @@ Adaptive mode attempts to strike a balan
 the system appears idle and increasing it when the system is busy.
 It offers a good balance between a small performance loss for greatly
 increased power savings.
-Hiadaptive mode is alike adaptive mode, but tuned for systems where
+Hiadaptive mode is like adaptive mode, but tuned for systems where
 performance and interactivity are more important then power consumption.
-It rises frequency faster, drops slower and keeps twice lower CPU load.
+It increases frequency faster, reduces the frequency less aggressively and
+will maintain full frequency for longer.
 The default mode is adaptive for battery power and hiadaptive for the rest.
 .Pp
 The
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 3 Gavin Atkinson freebsd_committer

2009-12-21 22:58:54 UTC

State Changed
From-To: open->patched

Fixed in HEAD, MFC in two weeks

Comment 4 Gavin Atkinson freebsd_committer

2009-12-21 22:58:54 UTC

Responsible Changed
From-To: freebsd-doc->gavin

Mine

Comment 5 dfilter service freebsd_committer

2010-01-06 20:54:22 UTC

Author: gavin
Date: Wed Jan  6 20:54:04 2010
New Revision: 201672
URL: http://svn.freebsd.org/changeset/base/201672

Log:
  MFC r200819:
  
    Grammar and minor tweaks to powerd(8) man page.
  
  PR:		docs/133186
  Approved by:	ed (mentor, implicit)

Modified:
  stable/8/usr.sbin/powerd/powerd.8
Directory Properties:
  stable/8/usr.sbin/powerd/   (props changed)

Modified: stable/8/usr.sbin/powerd/powerd.8
==============================================================================
--- stable/8/usr.sbin/powerd/powerd.8	Wed Jan  6 20:51:04 2010	(r201671)
+++ stable/8/usr.sbin/powerd/powerd.8	Wed Jan  6 20:54:04 2010	(r201672)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd December 24, 2008
+.Dd December 21, 2009
 .Dt POWERD 8
 .Os
 .Sh NAME
@@ -45,7 +45,7 @@ The
 .Nm
 utility monitors the system state and sets various power control options
 accordingly.
-It offers three modes (maximum, minimum, and adaptive) that can be
+It offers four modes (maximum, minimum, adaptive and hiadaptive) that can be
 individually selected while on AC power or batteries.
 The modes maximum, minimum, adaptive and hiadaptive may be abbreviated
 max, min, adp, hadp.
@@ -57,9 +57,10 @@ Adaptive mode attempts to strike a balan
 the system appears idle and increasing it when the system is busy.
 It offers a good balance between a small performance loss for greatly
 increased power savings.
-Hiadaptive mode is alike adaptive mode, but tuned for systems where
+Hiadaptive mode is like adaptive mode, but tuned for systems where
 performance and interactivity are more important then power consumption.
-It rises frequency faster, drops slower and keeps twice lower CPU load.
+It increases frequency faster, reduces the frequency less aggressively and
+will maintain full frequency for longer.
 The default mode is adaptive for battery power and hiadaptive for the rest.
 .Pp
 The
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 6 Gavin Atkinson freebsd_committer

2010-01-06 21:01:28 UTC

State Changed
From-To: patched->closed

Merged to 8.  Thanks for your bug report!