Docs: Deprecated DiscardHibernateMap, which is now scheduled for re…

…moval
acidanthera · Dec 2, 2019 · 58b19a8 · 58b19a8 · Andrey1970AppleLife · Dec 2, 2019
1 parent e2095b6
commit 58b19a8
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 6 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -14,6 +14,7 @@ OpenCore Changelog
 - Removed `ThirdPartyTrim` kernel quirk in favour of `ThirdPartyDrives`
 - Added Intel Xeon E5 (Broadwell-EP) support (thx @crazyi)
 - Switched to edk2-stable201911, which is now the minimum supportd EDK II version
+- Deprecated `DiscardHibernateMap`, which is now scheduled for removal
 
 #### v0.5.2
 - Fixed `MinKernel` and `MaxKernel` logic (thx @dhinakg, @reitermarkus)

diff --git a/Docs/Configuration.pdf b/Docs/Configuration.pdf
diff --git a/Docs/Configuration.tex b/Docs/Configuration.tex
@@ -1243,9 +1243,10 @@ \subsection{Quirks Properties}\label{booterpropsquirks}
   \href{https://docs.microsoft.com/en-us/windows-hardware/design/device-experiences/oem-uefi#hibernation-state-s4-transition-requirements}{preserve}
   runtime memory size and location after S4 wake.
 
-  \emph{Note}: This may be used to workaround buggy memory maps on older hardware,
-  and is now considered rare legacy. Do not use this unless you fully understand
-  the consequences.
+  \emph{Note}: This option is deprecated and will be removed in the newer OpenCore
+  releases. There is no known hardware that needs this option, and its entire existence
+  appears to be a programmer error. Please report on
+  \href{https://github.com/acidanthera/bugtracker}{Acidanthera Bugtracker} if you need this option.
 
 \item
   \texttt{EnableSafeModeSlide}\\

diff --git a/Docs/Differences/Differences.pdf b/Docs/Differences/Differences.pdf
diff --git a/Docs/Differences/Differences.tex b/Docs/Differences/Differences.tex
@@ -1,7 +1,7 @@
 \documentclass[]{article}
 %DIF LATEXDIFF DIFFERENCE FILE
 %DIF DEL PreviousConfiguration.tex   Sun Nov  3 16:31:21 2019
-%DIF ADD ../Configuration.tex        Sat Nov 30 23:55:09 2019
+%DIF ADD ../Configuration.tex        Mon Dec  2 05:21:21 2019
 
 \usepackage{lmodern}
 \usepackage{amssymb,amsmath}
@@ -1304,9 +1304,12 @@ \subsection{Quirks Properties}\label{booterpropsquirks}
   \href{https://docs.microsoft.com/en-us/windows-hardware/design/device-experiences/oem-uefi#hibernation-state-s4-transition-requirements}{preserve}
   runtime memory size and location after S4 wake.
 
-  \emph{Note}: This may be used to workaround buggy memory maps on older hardware,
+  \emph{Note}: This \DIFdelbegin \DIFdel{may be used to workaround buggy memory maps on older hardware ,
   and is now considered rare legacy. Do not use this unless you fully understand
-  the consequences.
+  the consequences}\DIFdelend \DIFaddbegin \DIFadd{option is deprecated and will be removed in the newer OpenCore
+  releases. There is no known hardware that needs this option, and its entire existence
+  appears to be a programmer error. Please report on
+  }\href{https://github.com/acidanthera/bugtracker}{Acidanthera Bugtracker} \DIFadd{if you need this option}\DIFaddend .
 
 \item
   \texttt{EnableSafeModeSlide}\\