ACPI is not documented at all in the Handbook. It does not show up in the INDEX. Multiple pages of user documentation need to be written for the Handbook to show users how to accomplish basic tasks with ACPI. How do you suspend a laptop with ACPI? What different suspend options are available? What is the difference between them? How do you use CPU throttling? What do common ACPI error messages mean? This is a important new feature for FreeBSD 5.0, and we must document it before November. The terse information in the man pages is not good enough by a long shot. We need more user-oriented documentation on these features. Fix: Add a new section for the handbook that covers ACPI.
On 30-Sep-2002 murray@FreeBSD.org wrote: > >>Number: 43528 >>Category: docs >>Synopsis: ACPI is not documented in the Handbook. >>Confidential: no >>Severity: serious >>Priority: high >>Responsible: freebsd-doc >>State: open >>Quarter: >>Keywords: >>Date-Required: >>Class: doc-bug >>Submitter-Id: current-users >>Arrival-Date: Mon Sep 30 09:20:01 PDT 2002 >>Closed-Date: >>Last-Modified: >>Originator: >>Release: FreeBSD 4.7-RC i386 >>Organization: > FreeBSD Mall, Inc. >>Environment: > System: FreeBSD builder.freebsdmall.com 4.7-RC FreeBSD 4.7-RC #17: Sun Sep 29 15:18:19 PDT 2002 > murray@builder.freebsdmall.com:/usr/obj/usr/src/sys/BUILDER i386 > >>Description: > > ACPI is not documented at all in the Handbook. It does not show up in > the INDEX. Multiple pages of user documentation need to be written > for the Handbook to show users how to accomplish basic tasks with > ACPI. > > How do you suspend a laptop with ACPI? What different suspend options > are available? What is the difference between them? The same exact way you do with apm. I.e. close the lid, hit the suspend key, etc. Is this even documented for apm(8)? > How do you use CPU throttling? You don't for the most part, that is behind the scenes. > What do common ACPI error messages mean? I don't even know what most of those are. :( Almost everything ACPI gives you is transparent. The same interface that apm used is supported, so battery status applets that work with APM will work with ACPI. The only difference is new features may work such as hitting the suspend key on the keyboard actually working and hitting the power button actually doing a clean power down and soft off. -- John Baldwin <jhb@FreeBSD.org> <>< http://www.FreeBSD.org/~jhb/ "Power Users Use the Power to Serve!" - http://www.FreeBSD.org/
Responsible Changed From-To: freebsd-doc->trhodes Task List.
--- Tom Rhodes <trhodes@FreeBSD.org> wrote: > Synopsis: ACPI is not documented in the Handbook. > > Responsible-Changed-From-To: freebsd-doc->trhodes > Responsible-Changed-By: trhodes > Responsible-Changed-When: Tue Nov 5 17:20:49 PST 2002 > Responsible-Changed-Why: > Task List. > > http://www.freebsd.org/cgi/query-pr.cgi?pr=43528 Hi there. I had started some work on the documentation of ACPI, but I am currently not doing any work on it, well, not atleast for another week or two because of mock examinations. However, I have some introductory stuff written, you can find it at: http://www.unixdaemons.com/~hiten/work/acpi Let me know if its useful to you. There is a chance I will be doing some work on it over this weekend. I have some other stuff written up too, on the ACPI sysctls and stuff, but not yet formatted. Cheers. -- Hiten hiten@unixdaemons.com, hiten@uk.FreeBSD.org, hiten@softweyr.com
State Changed From-To: open->closed Closed. I've added a nice chunk of information.