Date: Fri, 07 Jan 2022 01:05:17 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=260994 Bug ID: 260994 Summary: Sleep, wake: document the requirement for Kernel Mode Setting (KMS) drivers; include the console context Product: Documentation Version: Latest Hardware: Any URL: https://lists.freebsd.org/archives/freebsd-hackers/202 2-January/000741.html OS: Any Status: New Severity: Affects Some People Priority: --- Component: Documentation Assignee: doc@FreeBSD.org Reporter: email@example.com >>>> 𠈶… kms drm drivers. The suspend/resume code is in those drivers. They work >>>> console, X11 and wayland, more or less. … >>> … (handbook suspend/resume section, man zzz acpiconf, maybe apm too, wiki) >>> … drm kmod drivers to actually make resuming succeed on >>> console-only computers. … >> … drm kmod drivers usually are being associated as graphics drivers >> for xorg. Thus it is not at all intuitive/obvious that these are >> also required on console-only computers to make resuming succeed. >> >> … *not* mentioned anywhere in the documentation regarding suspend/resume, >> making users wonder why resuming fails. > Absolutely agreed on need more docs and an update pass. I raised it as > part of this year's core team meeting with the foundation. … likely > can be handled by a simple document PR. > > Warner For the benefit of newcomers to systems such as FreeBSD: let's (also) now use the FreeBSD Handbook glossary, which is currently detached from the Handbook, to demystify some of the more ambiguous/obscure phrases. <https://docs.freebsd.org/en/books/handbook/glossary/#_c> * add an entry for console. <https://docs.freebsd.org/en/books/handbook/glossary/#_d> * add an entry for DRM; see digital rights management and Direct Rendering Manager * digital rights management (maybe make a separate bug report) might simply state that Google's Widevine CDM <https://en.wikipedia.org/wiki/Widevine> is not a feature of any web browser in the FreeBSD ports collection * Direct Rendering Manager can refer to e.g. <https://en.wikipedia.org/wiki/Direct_Rendering_Manager>. <https://docs.freebsd.org/en/books/handbook/glossary/#_k> * add entry for KMS; see Kernel Mode Setting * Kernel Mode Setting can refer to e.g. <https://en.wikipedia.org/wiki/Direct_Rendering_Manager#Kernel_Mode_Setting> and FreeBSD Handbook section 18.104.22.168 (Suspend/resume). <https://docs.freebsd.org/en/books/handbook/glossary/#_t> * add an entry for ttys; see console. acpiconf(8) <https://www.freebsd.org/cgi/man.cgi?query=acpiconf&sektion=8&manpath=FreeBSD> apm(8) <https://www.freebsd.org/cgi/man.cgi?query=apm&sektion=8&manpath=FreeBSD> zzz(8) <https://www.freebsd.org/cgi/man.cgi?query=zzz&sektion=8&manpath=FreeBSD> <https://docs.freebsd.org/en/books/handbook/config/#acpi-config> <https://docs.freebsd.org/en/books/handbook/book/#acpi-config> <https://docs.freebsd.org/en/books/handbook/config/#ACPI-comprob> <https://docs.freebsd.org/en/books/handbook/book/#ACPI-comprob> <https://docs.freebsd.org/en/books/handbook/config/#_suspendresume> <https://docs.freebsd.org/en/books/handbook/book/#_suspendresume> <https://wiki.freebsd.org/SuspendResume> I'll bring in Stefan Blachmann (one of the people who are quoted above). -- You are receiving this mail because: You are the assignee for the bug.