Docs: Provide information on ConfigValidity

closes acidanthera/bugtracker#656
drfdr · May 29, 2020 · 507f4f2 · 507f4f2
1 parent bf8e36b
commit 507f4f2
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 2 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -38,6 +38,7 @@ OpenCore Changelog
 - Added ConfigValidity utility and improved config validation
 - Added serial port initialisation for serial debug logging
 - Disabled empty debug log file creation to avoid ESP cluttering
+- Added `TscSyncTimeout` quirk to workaround debug kernel assertions
 
 #### v0.5.8
 - Fixed invalid CPU object reference in SSDT-PLUG

diff --git a/Docs/Configuration.pdf b/Docs/Configuration.pdf
diff --git a/Docs/Configuration.tex b/Docs/Configuration.tex
@@ -365,6 +365,11 @@ \subsection{Configuration Structure}\label{configuration-structure}
   \hyperref[uefi]{\texttt{UEFI}}
 \end{itemize}
 
+It is possible to perform basic validation of the configuration by using
+\texttt{ConfigValidity} utility. Please note, that \texttt{ConfigValidity}
+must match the used OpenCore release and may not be able to detect all
+configuration flaws present in the file.
+
 \emph{Note}: Currently most properties try to have defined values even if not
 specified in the configuration for safety reasons. This behaviour should not
 be relied upon, and all fields must be properly specified in the configuration.

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   Mon May 11 17:11:58 2020
-%DIF ADD ../Configuration.tex        Sat May 30 01:22:19 2020
+%DIF ADD ../Configuration.tex        Sat May 30 01:33:51 2020
 
 \usepackage{lmodern}
 \usepackage{amssymb,amsmath}
@@ -437,7 +437,13 @@ \subsection{Configuration Structure}\label{configuration-structure}
   \hyperref[uefi]{\texttt{UEFI}}
 \end{itemize}
 
-\emph{Note}: Currently most properties try to have defined values even if not
+\DIFaddbegin \DIFadd{It is possible to perform basic validation of the configuration by using
+}\texttt{\DIFadd{ConfigValidity}} \DIFadd{utility. Please note, that }\texttt{\DIFadd{ConfigValidity}}
+\DIFadd{must match the used OpenCore release and may not be able to detect all
+configuration flaws present in the file.
+}
+
+\DIFaddend \emph{Note}: Currently most properties try to have defined values even if not
 specified in the configuration for safety reasons. This behaviour should not
 be relied upon, and all fields must be properly specified in the configuration.