Add docs on how to debug

README.md

@@ -9,16 +9,17 @@ Supported features:
 * System Integrity Protection, FileVault 2, .im4m Secure Boot and Vaulting
 * Native OTA OS DELTA updates on all Macs
 * Recovery OS, Safe Mode and Single-user Mode booting
-* Zero firmware patching required(ie. APFS ROM patching)
-* GPU Switching on MacBook Pro models(2012 and newer)
+* Zero firmware patching required (ie. APFS ROM patching)
+* GPU Switching on MacBook Pro models (2012 and newer)
 
 Note: Only clean-installs and upgrades are supported, installs already patched with [Patched-Sur](https://github.com/BenSova/Patched-Sur) or [bigmac](https://github.com/StarPlayrX/bigmac) cannot be used due to broken file integrity with APFS snapshots and SIP.
 
 * You can however reinstall macOS with this patcher and retain your original data
 
-Note 2: Currently OpenCore Legacy Patcher only supports macOS 11, Big Sur installs. For older OSes, please use [Dosdude1's patchers](http://dosdude1.com)
+Note 2: Currently OpenCore Legacy Patcher only supports macOS 11, Big Sur installs. For older OSes, please use [dosdude1's patchers](http://dosdude1.com)
 
 ## How to use
+
 See the online guide on how:
 
 * [OpenCore Legacy Patcher Guide](https://dortania.github.io/OpenCore-Legacy-Patcher/)
@@ -32,4 +33,14 @@ Since this patcher tricks macOS into thinking you're running a newer Mac, certai
 * Legacy Windows Booting
   * Currently OpenCore cannot boot MBR-based installs, so Ivy Bridge and older Machines may not be able to see Windows in OpenCore's Boot Picker
 * Boot Buddy support
-  * Due to how OpenCore overwrites NVRAM , the usage of Boot Buddy and such tools are **highly** in-advised 
+  * Due to how OpenCore overwrites NVRAM , the usage of Boot Buddy and such tools are **highly** in-advised
+  
+## Support
+
+To get aid with the patcher, we recommend joining the [Unsupported Mac Discord Server](https://discord.gg/XbbWAsE) and heading over to our `#opencore-patcher` channel. We're actively there and is the quickest way to receive help. For bigger issues such as patcher crashing on build and such, we recommend opening an issue right here on GitHub:
+
+* [OpenCore Legacy Patcher's Issue's tab](https://github.com/dortania/OpenCore-Legacy-Patcher/issues)
+
+Regarding how to debug OpenCore Patcher, we recommend seeing the below:
+
+* [How to debug with OpenCore](https://dortania.github.io/OpenCore-Legacy-Patcher/DEBUG.html)

Resources/Constants.py

@@ -8,7 +8,7 @@ from pathlib import Path
 
 class Constants:
     def __init__(self):
-        self.patcher_version = "0.0.18"
+        self.patcher_version = "0.0.19"
         self.opencore_commit = "7bb41aa - 2021-03-06"
         self.opencore_version = "0.6.8"
         self.lilu_version = "1.5.1"

Resources/build.py

@@ -236,7 +236,7 @@ class BuildOpenCore:
         if self.constants.verbose_debug is True:
             print("- Enabling Verbose boot")
             self.config["Kernel"]["Quirks"]["PanicNoKextDump"] = True
-            self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"] += " -v"
+            self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"] += " -v debug=0x100"
         if self.constants.kext_debug is True:
             print("- Enabling DEBUG Kexts")
             self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"] += " -liludbgall"
@@ -244,6 +244,7 @@ class BuildOpenCore:
         if self.constants.opencore_debug is True:
             print("- Enabling DEBUG OpenCore")
             self.config["Misc"]["Debug"]["Target"] = 67
+            self.config["Misc"]["Debug"]["DisplayLevel"] = 672151678018
         if self.constants.showpicker is True:
             print("- Enabling ShowPicker")
             self.config["Misc"]["Boot"]["ShowPicker"] = True

docs/.vuepress/config.js

@@ -96,6 +96,7 @@ module.exports = {
             sidebarDepth: 1,
             children: [
 				'TROUBLESHOOTING',
+				'DEBUG',
 				'UNINSTALL',
 				'ICNS',
             ]

docs/DEBUG.md

@@ -0,0 +1,49 @@
+# How to debug with OpenCore
+
+For those who've hit an odd bug and unsure if it's user error or patcher, the below will tell you how to get more verbose debug information as well as logs to help [file issues with us](https://github.com/dortania/OpenCore-Legacy-Patcher/issues)
+
+* For users who are less experienced, we recommend asking on the [Unsupported Mac Discord Server](https://discord.gg/XbbWAsE) for help.
+
+## Debugging yourself
+
+The easiest way to debug yourself is via Patcher Settings. Here there are many different settings however the 3 main options that will help are:
+
+* "Enable Verbose Mode"
+* "Enable OpenCore DEBUG"
+* "Enable Kext DEBUG"
+
+
+When you've enabled these 3 options, rebuild OpenCore and install to your drive. This will provide much greater debug information as well as write logs to the EFI Partition.
+
+## Obtaining OpenCore logs from disk
+
+With "Enable OpenCore DEBUG" set, every boot there will be a .txt file generated in your disk. To grab these logs, [download and run MountEFI](https://github.com/corpnewt/MountEFI):
+
+![](../images/mountefi.png)
+
+Once you've mounted the EFI Partition of the drive you have macOS on, you should see some nice logs:
+
+![](../images/logs-efi.png)
+
+## Obtaining Kernel logs from macOS
+
+With "Enable Kext DEBUG" set, every boot will now have much more detailed logs stored in the OS. To get these logs, simply run the below command:
+
+```sh
+sudo dmesg > ~/Desktop/DMESG.txt
+```
+
+From there, you'll have a log on your desktop.
+
+## Filing an issue with us
+
+Now that you have proper logs, you can now [file issues with us](https://github.com/dortania/OpenCore-Legacy-Patcher/issues). Reminder we want the following info:
+
+* Model patching for (ie. MacBookPro10,1)
+* Target OS (ie. macOS 11.2.3)
+* Host OS (ie. macOS 10.15.7)
+* Upload of your OpenCore Build Folder
+* Upload of your OpenCore log (if applicable)
+* Upload of your Kernel log (if applicable)
+
+Additionally, please search whether the issue has been reported before. This avoids having duplicate issues.

docs/POST-INSTALL.md

@@ -26,4 +26,4 @@ Here you can change different patcher settings, however the main 2 of interest a
 * Enable Verbose Mode
 * Set ShowPicker Mode
 
-Once you've toggled them both off, build your OpenCore EFI once again and install to your desired drive. Now to show OpenCore picker, you can simply press "Esc" key repeatedly.
+Once you've toggled them both off, build your OpenCore EFI once again and install to your desired drive. Now to show OpenCore picker, you can simply hold the "Esc" key.

docs/TROUBLESHOOTING.md

@@ -8,6 +8,7 @@ Here are some common errors users may experience while using this patcher:
 * [Reboot when entering Hibernation (`Sleep Wake Failure`)](#reboot-when-entering-hibernation-sleep-wake-failure)
 * [Booting with a non-flashed GPU](#booting-with-a-non-flashed-gpu)
 * [How to Boot Big Sur Recovery](#how-to-boot-big-sur-recovery)
+* [Stuck on "Your Mac needs a firmware update"](#stuck-on-your-mac-needs-a-firmware-update)
 
 ## Stuck on `This version of Mac OS X is not supported on this platform`
 
@@ -50,4 +51,11 @@ Once you boot OpenCore for the first time, LauncherOption will install itself as
 
 ## How to Boot Big Sur Recovery
 
-By default, the patcher will try to hide extra boot options such as recovery from the user. To make them appear, simply press the "Spacebar" inside OpenCore's Picker to list all boot options.
+By default, the patcher will try to hide extra boot options such as recovery from the user. To make them appear, simply press the "Spacebar" inside OpenCore's Picker to list all boot options.
+
+## Stuck on "Your Mac needs a firmware update"
+
+Full error: "Your Mac needs a firmware update in order to install to this Volume. Please select a Mac OS Extended (Journaled) volume instead."
+
+
+This error occurs when macOS determines the firmware to not have full APFS support. To resolve is quite simple, when building OpenCore head to "Patcher Settings" and enable "Moderate SMBIOS Patching" or higher. This will ensure that the firmware reported will show as supporting full APFS capabilities.