Docs: Agreed changes to UIScale and ForceOcWriteFlash docs

ldebug · Nov 5, 2021 · 3c77126 · 3c77126
1 parent 841eab2
commit 3c77126
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 10 deletions.
diff --git a/Docs/Configuration.pdf b/Docs/Configuration.pdf
diff --git a/Docs/Configuration.tex b/Docs/Configuration.tex
@@ -1738,7 +1738,7 @@ \subsection{Quirks Properties}\label{booterpropsquirks}
   value for this quirk is the minimal supported BAR size, i.e. \texttt{0}. Use
   \texttt{-1} to disable this quirk.
 
-  For the development purposes one may take the risks and try other values.
+  For development purposes one may take risks and try other values.
   Consider a GPU with 2 BARs:
   \begin{itemize}
     \tightlist
@@ -7379,6 +7379,11 @@ \subsection{Output Properties}\label{uefioutputprops}
     \item \texttt{0} --- automatically chooses scaling based on the current resolution.
   \end{itemize}
 
+  \emph{Note 1}: Automatic scale factor detection works on the basis of total pixel area and may fail on small HiDPI displays,
+  in which case the value may be manually managed using the NVRAM section.
+
+  \emph{Note 2}: When switching from manually specified NVRAM variable to this preference an NVRAM reset may be needed.
+
 \item
   \texttt{UgaPassThrough}\\
   \textbf{Type}: \texttt{plist\ boolean}\\
@@ -7626,7 +7631,7 @@ \subsection{Quirks Properties}\label{uefiquirkprops}
   \texttt{ForceOcWriteFlash}\\
   \textbf{Type}: \texttt{plist\ boolean}\\
   \textbf{Failsafe}: \texttt{false}\\
-  \textbf{Description}: Enables writing to flash memory for all OpenCore system variables.
+  \textbf{Description}: Enables writing to flash memory for all OpenCore-managed NVRAM system variables.
 
   \emph{Note}: This value should be disabled on most types of firmware but is
   left configurable to account for firmware that may have issues with volatile

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   Wed Nov  3 14:16:04 2021
-%DIF ADD ../Configuration.tex        Thu Nov  4 18:36:53 2021
+%DIF DEL PreviousConfiguration.tex   Tue Nov  2 07:56:56 2021
+%DIF ADD ../Configuration.tex        Fri Nov  5 18:33:39 2021
 
 \usepackage{lmodern}
 \usepackage{amssymb,amsmath}
@@ -1804,7 +1804,7 @@ \subsection{Quirks Properties}\label{booterpropsquirks}
   value for this quirk is the minimal supported BAR size, i.e. }\texttt{\DIFadd{0}}\DIFadd{. }\DIFaddend Use
   \texttt{-1} to disable this quirk.
 
-  \DIFaddbegin \DIFadd{For the development purposes one may take the risks and try other values.
+  \DIFaddbegin \DIFadd{For development purposes one may take risks and try other values.
   }\DIFaddend Consider a GPU with 2 BARs:
   \begin{itemize}
     \tightlist
@@ -7437,10 +7437,9 @@ \subsection{Output Properties}\label{uefioutputprops}
   \emph{Note}: This option only applies to the \texttt{System} renderer.
    On all known affected systems, \texttt{ConsoleMode} must be set to
    an empty string for this option to work.
-\DIFaddbegin 
 
 \item
-  \texttt{\DIFadd{UIScale}}\\
+  \DIFaddbegin \texttt{\DIFadd{UIScale}}\\
   \textbf{\DIFadd{Type}}\DIFadd{: }\texttt{\DIFadd{plist\ integer}}\DIFadd{, 8 bit}\\
   \textbf{\DIFadd{Failsafe}}\DIFadd{: }\texttt{\DIFadd{-1}}\\
   \textbf{\DIFadd{Description}}\DIFadd{: User interface scaling factor.
@@ -7454,10 +7453,16 @@ \subsection{Output Properties}\label{uefioutputprops}
     }\item \texttt{\DIFadd{-1}} \DIFadd{--- leaves the current variable unchanged.
     }\item \texttt{\DIFadd{0}} \DIFadd{--- automatically chooses scaling based on the current resolution.
   }\end{itemize}
-\DIFaddend 
+
+  \emph{\DIFadd{Note 1}}\DIFadd{: Automatic scale factor detection works on the basis of total pixel area and may fail on small HiDPI displays,
+  in which case the value may be manually managed using the NVRAM section.
+}
+
+  \emph{\DIFadd{Note 2}}\DIFadd{: When switching from manually specified NVRAM variable to this preference an NVRAM reset may be needed.
+}
 
 \item
-  \texttt{UgaPassThrough}\\
+  \DIFaddend \texttt{UgaPassThrough}\\
   \textbf{Type}: \texttt{plist\ boolean}\\
   \textbf{Failsafe}: \texttt{false}\\
   \textbf{Description}: Provide UGA protocol instances on top of GOP protocol instances.
@@ -7703,7 +7708,7 @@ \subsection{Quirks Properties}\label{uefiquirkprops}
   \texttt{ForceOcWriteFlash}\\
   \textbf{Type}: \texttt{plist\ boolean}\\
   \textbf{Failsafe}: \texttt{false}\\
-  \textbf{Description}: Enables writing to flash memory for all OpenCore system variables.
+  \textbf{Description}: Enables writing to flash memory for all \DIFdelbegin \DIFdel{OpenCore }\DIFdelend \DIFaddbegin \DIFadd{OpenCore-managed NVRAM }\DIFaddend system variables.
 
   \emph{Note}: This value should be disabled on most types of firmware but is
   left configurable to account for firmware that may have issues with volatile

diff --git a/Docs/Errata/Errata.pdf b/Docs/Errata/Errata.pdf