From 3e47853e7570091e91b2fbf40adc08c5e54f2705 Mon Sep 17 00:00:00 2001 From: Mykola Grymalyuk <48863253+khronokernel@users.noreply.github.com> Date: Thu, 27 May 2021 10:11:59 -0600 Subject: [PATCH] Fix linting --- docs/ACCEL.md | 2 +- docs/BENIFITS.md | 6 +++--- docs/BOOT.md | 1 - docs/BUILD.md | 9 ++++----- docs/CLI.md | 6 +++--- docs/DEBUG.md | 3 +-- docs/HOW.md | 2 +- docs/ICNS.md | 8 +++----- docs/INSTALLER.md | 1 + docs/LICENSE.md | 2 +- docs/MODELS.md | 1 - docs/PATCHEXPLAIN.md | 12 ++++++------ docs/START.md | 2 +- docs/TESTED.md | 1 - docs/TROUBLESHOOTING.md | 3 +-- docs/UNINSTALL.md | 15 +++++++++------ docs/UPDATE.md | 4 ++-- docs/WINDOWS.md | 2 +- 18 files changed, 38 insertions(+), 42 deletions(-) diff --git a/docs/ACCEL.md b/docs/ACCEL.md index a1f688b3b..1292b4b7a 100644 --- a/docs/ACCEL.md +++ b/docs/ACCEL.md @@ -62,4 +62,4 @@ The best way to achieve this is to boot Recovery (or Single User Mode if the dGP nvram fa4ce28d-b62f-4c99-9cc3-6815686e30f9:gpu-power-prefs=%01%00%00%00 ``` -This will disable the dGPU and allow graphics acceleration in Big Sur. Note that external display outputs are directly routed to the dGPU and therefore can no longer be used. Solutions such as a [DisplayLink Adapters](https://www.displaylink.com/products/usb-adapters) can work around this limitation. \ No newline at end of file +This will disable the dGPU and allow graphics acceleration in Big Sur. Note that external display outputs are directly routed to the dGPU and therefore can no longer be used. Solutions such as a [DisplayLink Adapters](https://www.displaylink.com/products/usb-adapters) can work around this limitation. diff --git a/docs/BENIFITS.md b/docs/BENIFITS.md index 4bb1ce219..d472fbbbd 100644 --- a/docs/BENIFITS.md +++ b/docs/BENIFITS.md @@ -7,10 +7,10 @@ With OpenCore Legacy Patcher we recommend users go through the below table to un | Features | [OpenCore Legacy Patcher](https://github.com/dortania/OpenCore-Legacy-Patcher/) | [Patched Sur](https://github.com/BenSova/Patched-Sur) | | :--- | :--- | :--- | | Over The Air Updates | Native System Preferences, additionally supports Deltas (~2GB) for Metal GPUs | Inside Patcher Sur app (~12GB), only available when InstallAssistants release. InstallAssistants generally available same day as System Preference updates, however developer betas will lag behind by 1 day compared to OTAs | -| FileVault | Supported on Metal GPUs | Not supported | +| FileVault | Supported on Metal GPUs | Not supported | | System Integrity Protection | Fully enabled on Metal GPUs | Disabled for early 2013 and older during the patching process and first boot afterwards, otherwise enabled | | APFS Snapshots | Fully enabled | Disabled | -| User facing | TUI interface | SwiftUI interface, more user friendly | +| User facing | TUI interface | SwiftUI interface, more user friendly | | Supported OSes | 10.7-11 | 10.15-11 | | Firmware Patching | None required | Required for models without native APFS support | | BootCamp Switching | Requires EFI Conversion for Start Disk support, otherwise still supported | Native | @@ -21,4 +21,4 @@ With OpenCore Legacy Patcher we recommend users go through the below table to un | HEVC/H.265 Support for Mac Pros and iMacs with Polaris+ GPUs | Supported | Not supported | | Big Sur-styled Boot Picker | Available, though as a shim to the original boot picker | Not available | | Hibernation Support | Supports 3rd party SATA SSDs on 2011 and older models in addition to stock drives | Only supports stock drives on 2011 and older models | -| Sidecar Support | Supports any Mac with Metal Intel iGPU, artifacting way exhibited on high movement screen content | Not supported at all | \ No newline at end of file +| Sidecar Support | Supports any Mac with Metal Intel iGPU, artifacting way exhibited on high movement screen content | Not supported at all | diff --git a/docs/BOOT.md b/docs/BOOT.md index 574d40d30..41c905f7d 100644 --- a/docs/BOOT.md +++ b/docs/BOOT.md @@ -14,7 +14,6 @@ Now that you've loaded OpenCore, now select Install macOS!: ![](../images/oc-boot.png) - After plenty of verbose booting, you will reach the installer screen! From there it's just like any normal macOS install. For an example of how the boot process looks, see the following video: * [OpenCore Legacy Patcher Boot Process](https://www.youtube.com/watch?v=AN3zsbQV_n4) diff --git a/docs/BUILD.md b/docs/BUILD.md index 89bed91ab..870527c84 100644 --- a/docs/BUILD.md +++ b/docs/BUILD.md @@ -2,7 +2,7 @@ Now that we have a macOS installer, lets now build our OpenCore configuration! -First Download the latest release: +First Download the latest release: * [OpenCore Legacy Patcher Releases](https://github.com/dortania/Opencore-Legacy-Patcher/releases) @@ -15,7 +15,7 @@ From here you have a couple important options: * Build OpenCore * Install OpenCore to USB/internal drive * Change Model -* Patcher Settings +* Patcher Settings If you're patching for a different machine than you're running, please select "Change Model" and enter the updated SMBIOS. For more advanced users, you may also tweak the patcher's build settings via "Patcher Settings" @@ -31,7 +31,6 @@ Next lets run `Install OpenCore to USB/internal drive`: | :--- | :--- | | ![](../images/disk-start.png) | ![](../images/disk-efi.png) | - * If you have issues, please ensure you install OpenCore onto a FAT32 partition to ensure your Mac is able to boot it. You will need to format your drive as GUID/GPT in Disk Utility +* If you have issues, please ensure you install OpenCore onto a FAT32 partition to ensure your Mac is able to boot it. You will need to format your drive as GUID/GPT in Disk Utility - -# Once finished, head to [Booting OpenCore and macOS](./BOOT.md) \ No newline at end of file +# Once finished, head to [Booting OpenCore and macOS](./BOOT.md) diff --git a/docs/CLI.md b/docs/CLI.md index beacc3690..861aad6aa 100644 --- a/docs/CLI.md +++ b/docs/CLI.md @@ -8,9 +8,9 @@ With OpenCore Legacy Patcher, we include an extra binary called [OCLP-CLI](https * **--model xxxx**: override default model detection * ex. **--model iMac11,2** * **--metal_gpu xxxx**: override default GPU detection (ie. Nvidia, AMD) - * **--metal_gpu Nvidia** + * **--metal_gpu Nvidia** * **--smbios_spoof xxxx**: set spoofing mode, defaults to Minimal if no arg provided (ie. Minimal, Moderate, Advanced) - * ex. **--smbios_spoof Moderate** + * ex. **--smbios_spoof Moderate** * **--verbose**: enable verbose booting * **--debug_oc**: enable debug OpenCore * **--debug_kext**: enable debug kexts @@ -38,4 +38,4 @@ Example usage: sudo ./OCLP-CLI --patch_sys_vol ``` -Note, root volume patching needs to be run as sudo \ No newline at end of file +Note, root volume patching needs to be run as sudo diff --git a/docs/DEBUG.md b/docs/DEBUG.md index 79fb5d0e1..1eb3a2bb1 100644 --- a/docs/DEBUG.md +++ b/docs/DEBUG.md @@ -12,7 +12,6 @@ The easiest way to debug yourself is via Patcher Settings. Here there are many d * "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 @@ -46,4 +45,4 @@ Now that you have proper logs, you can now [file issues with us](https://github. * 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. \ No newline at end of file +Additionally, please search whether the issue has been reported before. This avoids having duplicate issues. diff --git a/docs/HOW.md b/docs/HOW.md index 54bbce331..ac46c9e75 100644 --- a/docs/HOW.md +++ b/docs/HOW.md @@ -6,4 +6,4 @@ OpenCore Legacy Patcher itself is actually quite a "dumb" program, and essential To understand a bit more of how OpenCore is able revive older Macs in such a native-like way, we need to go over *how* OpenCore works with your Mac: -![](../images/oc-explained.png) \ No newline at end of file +![](../images/oc-explained.png) diff --git a/docs/ICNS.md b/docs/ICNS.md index 7c3d27220..45a0ece22 100644 --- a/docs/ICNS.md +++ b/docs/ICNS.md @@ -2,12 +2,10 @@ For users who want to customize your setup to be more personal, OpenCore does allow for custom icons and images in the boot picker. - * [Custom OpenCore icons](#custom-opencore-icons) * [Custom Mac Boot Picker icons](#custom-mac-boot-picker-icons) * [Installing updated icons](#installing-updated-icons) - # Custom OpenCore icons To generate custom OpenCore icons, you'll need the following: @@ -32,7 +30,6 @@ To generate custom OpenCore icons, you'll need the following: Note, for each image we recommend having one of double the size. This ensures that icons are scaled correctly since .icns support dedicated images depending on HiDPI or not. - Once you have a custom image you want to use(for example, as a background), download the [latest release of OpenCorePkg](https://github.com/acidanthera/OpenCorePkg/releases) and enter the `Utilities/icnspack/` folder: ![](../images/icnspack-folder.png) @@ -42,6 +39,7 @@ Now `cd` this folder in terminal and run the following: ```sh ./icnspack Background.icns ``` + Once done, you'll see your custom icon generated in `icnspack`'s folder: ![](../images/icnspack-done.png) @@ -54,7 +52,7 @@ To generate legacy icons, you'll need the following: * A machine running macOS 10.4 through 10.11 * Icon Composer.app (Requires Apple Developer Account for official download) - * Users without the developer account can find a mirrors here: + * Users without the developer account can find a mirrors here: * [Icon Composer 10.6](https://github.com/dortania/OpenCore-Legacy-Patcher/blob/main/docs/Icon-Composer-10.6.zip) * [Icon Composer 10.11](https://github.com/dortania/OpenCore-Legacy-Patcher/blob/main/docs/Icon-Composer-10.11.zip) * PNG Image you wish to convert @@ -102,4 +100,4 @@ To update the Mac Boot Picker icons is actually quite simple, on the root of you ![](../images/mac-icns-drive.png) -Now reboot and you'll see the new icon! \ No newline at end of file +Now reboot and you'll see the new icon! diff --git a/docs/INSTALLER.md b/docs/INSTALLER.md index dd5c39746..fe2b26e05 100644 --- a/docs/INSTALLER.md +++ b/docs/INSTALLER.md @@ -14,6 +14,7 @@ The simplest way to download macOS installs would be to use installinstallmacos: ```sh [ ! -d ~/macOS-installer/ ] && mkdir ~/macOS-installer; cd ~/macOS-installer; [ ! -f ~/macOS-installer/installinstallmacos.py ] && curl -O https://raw.githubusercontent.com/munki/macadmin-scripts/main/installinstallmacos.py; sudo python installinstallmacos.py ``` + * Note: On El Capitan (10.11) and older, you'll need to specify a catalog at the end of the command: ``` diff --git a/docs/LICENSE.md b/docs/LICENSE.md index eb77cac2e..a2c54f637 100644 --- a/docs/LICENSE.md +++ b/docs/LICENSE.md @@ -19,4 +19,4 @@ This patcher is made of multiple external applications from different people and * [SidecarFixup](https://github.com/khronokernel/SidecarFixup) - Khronokernel * Apple Binaries - Apple Inc. -Remaining files within OpenCore Legacy Patcher are copyrighted 2020-2021 Mykola Grymalyuk & Dhinak G. For integration into other projects, please request written permission. \ No newline at end of file +Remaining files within OpenCore Legacy Patcher are copyrighted 2020-2021 Mykola Grymalyuk & Dhinak G. For integration into other projects, please request written permission. diff --git a/docs/MODELS.md b/docs/MODELS.md index f7bbd45d7..8303c62ea 100644 --- a/docs/MODELS.md +++ b/docs/MODELS.md @@ -126,7 +126,6 @@ Regarding OS support, see below: | MacPro4,1 | Early 2009 | ^^ | Everything is supported as long as GPU is Metal capable | | MacPro5,1 | Mid-2010, Mid-2012 | ^^ | ^^ | - ### Xserve | SMBIOS | Year | Supported | Comment | diff --git a/docs/PATCHEXPLAIN.md b/docs/PATCHEXPLAIN.md index f404406c7..319a66ed3 100644 --- a/docs/PATCHEXPLAIN.md +++ b/docs/PATCHEXPLAIN.md @@ -100,11 +100,12 @@ Below is a run down of the main logic OpenCore Legacy Patcher uses to gain nativ * Reason: Fixes DRM support on models with upgraded AMD Metal GPUs * Logic: Adds args to NVRAM * Models: Models with upgraded AMD Metal GPUs + ### UEFI -> ProtocolOverrides * GopPassThrough * Reason: Used for proper output on machines with UGA firmware but GOP GPU - * Logic: Provide GOP protocol instances on top of UGA protocol instances + * Logic: Provide GOP protocol instances on top of UGA protocol instances * Models: MacPro3,1, MacBook4,1 iMac7,1-8,1 ::: @@ -191,7 +192,6 @@ Below is an explanation of what Kexts OpenCore Legacy Patcher will inject into m * Models: All models require ::: - ## On-Disk Patches Unfortunately certain on-disk patches are required to achieve full functionality. Below is a breakdown of patches supported @@ -226,15 +226,15 @@ Note, GPU Acceleration Patches are not public yet, the below section is simply d * GeForceGA.bundle * GeForceTesla.kext * Skip IOFree Panic - Mojave+ - * At Offset `0x5CF9A` replace following bytes with `0xEB` + * At Offset `0x5CF9A` replace following bytes with `0xEB` * Avoids `addMemoryRegion/removeMemoryRegion` calls * At Offset `0x5527` and `0x77993`, replace following bytes with `0x909090909090` * GeForceTeslaGLDriver.bundle * GeForceTeslaVADriver.bundle * NVDANV50HalTesla.kext * NVDAResmanTesla.kext - * 0x1ea59a - 0x1ea5b3: nop - * Replace VSLGestalt to IOLockLock or any other known symbol of the same length. + * 0x1ea59a - 0x1ea5b3: nop + * Replace VSLGestalt to IOLockLock or any other known symbol of the same length. * AMD/ATI Binaries * AMD2400Controller.kext @@ -274,7 +274,7 @@ Note, GPU Acceleration Patches are not public yet, the below section is simply d * AppleIntelHD3000GraphicsVADriver.bundle * AppleIntelSNBGraphicsFB.kext * Board ID Patch - * Replace original Board ID with updated model + * Replace original Board ID with updated model * AppleIntelSNBVA.bundle ### Frameworks diff --git a/docs/START.md b/docs/START.md index c2428c625..7b9328ea7 100644 --- a/docs/START.md +++ b/docs/START.md @@ -18,7 +18,7 @@ For those who wish to support this patcher, please see the [Supporting the Patch Since this patcher tricks macOS into thinking you're running a newer Mac, certain functionality may be broken: * Boot Camp Assistant.app - * We recommend following our [guide on getting a UEFI Windows Install working](). Legacy MBR Based installs won't show up in OpenCore + * We recommend following our [guide on getting a UEFI Windows Install working](./WINDOWS.md). Legacy MBR Based installs won't show up in OpenCore ## How do I get started? diff --git a/docs/TESTED.md b/docs/TESTED.md index dc4d33d91..13baafcdc 100644 --- a/docs/TESTED.md +++ b/docs/TESTED.md @@ -2,7 +2,6 @@ To aid users in troubleshooting, we've compiled a list of users who've reported success with OpenCore Legacy patcher as well as the version used. This should aid users in verifying whether issues with the patcher are regression-related with newer versions. - ### MacBook | SMBIOS | Tested | Tester | Comment | diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index 0584fdaa1..fdc3a1866 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -59,7 +59,6 @@ By default, the patcher will try to hide extra boot options such as recovery fro 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. ## No Brightness Control @@ -68,4 +67,4 @@ With OCLP v0.0.22, we've added support for brightness control on many models. Ho To work-around, we recommend user try out the below app: -* [Brightness Slider](https://actproductions.net/free-apps/brightness-slider/) \ No newline at end of file +* [Brightness Slider](https://actproductions.net/free-apps/brightness-slider/) diff --git a/docs/UNINSTALL.md b/docs/UNINSTALL.md index c2ab54efa..6fe635a68 100644 --- a/docs/UNINSTALL.md +++ b/docs/UNINSTALL.md @@ -3,10 +3,13 @@ To remove OpenCore is actually quite simply: 1. Remove OpenCore either from the USB or internal drive - * You'll need to mount the drive's EFI partition, and delete the EFI/OC folder as well as the System folder - * Note **do not** delete the entire EFI folder, this will likely break any existing Windows and Linux installations - * [See here for example how to mount](https://dortania.github.io/OpenCore-Post-Install/universal/oc2hdd.html) -2. Reset NVRAM - * [Reset NVRAM or PRAM on your Mac](https://support.apple.com/HT204063) -Know that if you are on Big Sur when you remove the EFI folder, your Mac will no longer boot and show the prohibited symbol. Be ready to install an older version of macOS before you uninstall OpenCore. \ No newline at end of file +* You'll need to mount the drive's EFI partition, and delete the EFI/OC folder as well as the System folder + * Note **do not** delete the entire EFI folder, this will likely break any existing Windows and Linux installations +* [See here for example how to mount](https://dortania.github.io/OpenCore-Post-Install/universal/oc2hdd.html) + +2. Reset NVRAM + +* [Reset NVRAM or PRAM on your Mac](https://support.apple.com/HT204063) + +Know that if you are on Big Sur when you remove the EFI folder, your Mac will no longer boot and show the prohibited symbol. Be ready to install an older version of macOS before you uninstall OpenCore. diff --git a/docs/UPDATE.md b/docs/UPDATE.md index 7f9079648..b680bbbbb 100644 --- a/docs/UPDATE.md +++ b/docs/UPDATE.md @@ -1,4 +1,4 @@ -# Updating OpenCore and Co. +# Updating OpenCore and Co With OpenCore Legacy Patcher, generally there's very little reason for users to update the OpenCore installed on their machine unless you feel there's a benefit with new versions for your setup. @@ -19,4 +19,4 @@ nvram 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:OCLP-Version ![](../images/oclp-version.png) -From this, we can see we're running a RELEASE version of OpenCore 0.6.8 built on March 27th, 2021 with Patcher Version 0.0.20! \ No newline at end of file +From this, we can see we're running a RELEASE version of OpenCore 0.6.8 built on March 27th, 2021 with Patcher Version 0.0.20! diff --git a/docs/WINDOWS.md b/docs/WINDOWS.md index 010623086..cc4c8eea5 100644 --- a/docs/WINDOWS.md +++ b/docs/WINDOWS.md @@ -75,7 +75,7 @@ Once done, lets reboot into OpenCore's Menu and you'll see a new Windows' entry: ![](../images/oc-windows.png) -From there, install Windows as normal and you'll get a new BootCamp entry in OpenCore's picker when done! +From there, install Windows as normal and you'll get a new BootCamp entry in OpenCore's picker when done! * Don't forget to run BootCamp's utilities installer as well to ensure Wifi and such are functioning correctly. This can be downloaded from the BootCamp Assistant app in macOS