Bug 216753

Summary:	ACPI documentation needs cleaning up
Product:	Documentation	Reporter:	Andriy Gapon <avg>
Component:	Books & Articles	Assignee:	Sergio Carlavilla Delgado <carlavilla>
Status:	Closed FIXED
Severity:	Affects Some People	CC:	acpi, doc
Priority:	---
Version:	Latest
Hardware:	Any
OS:	Any
See Also:	https://reviews.freebsd.org/D41052

Description Andriy Gapon freebsd_committer

2017-02-03 13:09:10 UTC

Taking for instance this handbook chapter:
https://www.freebsd.org/doc/handbook/acpi-overview.html

I think that nowadays we can safely remove the language about APM as it is not used anymore.
Chapter 11.13.1 incorrectly states that acpi should not be compiled into the kernel while exactly the opposite is the case for the modern FreeBSD.
Same chapter advises to try to disable acpi as a debugging measure, but the most likely outcome of that is an unbootable system.

Generally, all the mentions of acpi.ko module should be changed to refer to the acpi kernel device.  All advice on disabling acpi and apic should be removed.
We should change the language that describes ACPI as something new and buggy as nowadays ACPI is very well supported and tested.

Some of that medicine should also be applied to https://www.freebsd.org/cgi/man.cgi?acpi as well.

Comment 1 Sergio Carlavilla Delgado freebsd_committer

2023-07-17 18:17:58 UTC

I'm gonna start with this PR in the Handbook working group.
This section needs a real clean up :)

Comment 2 Sergio Carlavilla Delgado freebsd_committer

2023-08-01 09:49:16 UTC

Fixed, sorry for the delay.
And it's true, we need to clean the ACPI manual pages too.

Maybe after finish the Handbook and the FAQ working groups, maybe I'll start a manual pages working group.

Comment 3 Graham Perrin freebsd_committer

2023-09-03 11:57:43 UTC

<https://github.com/freebsd/freebsd-doc/commit/9401f487d47fb9147a5c6792e0318b9389749de3> 

----

 Handbook-WG: Upgrade config chapter

Changes:

* Change the title of the chapter to be more acurate
* Add a config files entry (/etc, /usr/local/etc), and /etc/sysctl.conf
* Rework the entry "managing services in FreeBSD"
* Upgrade cron section and add periodic info
* Upgrade syslog section
* Remove tuning section, some parts are really outdated
* Upgrade power management section
* Little upgrades to swap section

ACPI info obtained from:

* https://freebsdfoundation.org/wp-content/uploads/2022/04/ACPI-Support-for-Embedded-Controllers.pdf
* https://freebsdfoundation.org/wp-content/uploads/2018/04/Pain-and-Suffering-on-the-Road-to-Resume.pdf
* https://wiki.freebsd.org/ACPI
* https://papers.freebsd.org/2002/watanabe-acpi.files/watanabe-acpi-paper.pdf
* https://vermaden.wordpress.com/2018/11/28/the-power-to-serve-freebsd-power-management/
* https://github.com/freebsd/drm-kmod/blob/master/drivers/gpu/drm/i915/i915_params.c

PR:                             219953,260994,216753
Differential Revision:          https://reviews.freebsd.org/D41052
Reviewed by:                    fernape, karels
Sponsored by:                   Daifressh