archive-gh-me/OpenCorePkg
1
0
Fork 0
mirror of https://github.com/acidanthera/OpenCorePkg.git synced 2025-12-08 19:25:01 +00:00
Code Issues Projects Releases Wiki Activity

Docs: Volume icons: clarify file locations; explain our position regarding Apple's broken method; reword existing note about internal/external drives (#203)

Browse Source 
Co-authored-by: MikeBeaton <mjsbeaton@gmail.com>
This commit is contained in:
Bmju 2021-02-12 12:38:34 +00:00 committed by GitHub
parent 6ab51a83f0
commit 9f3acee803
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 48 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
Docs/Configuration.pdf
View File

Binary file not shown.

27
Docs/Configuration.tex
View File

@ -3092,16 +3092,33 @@ entry choice will update till next manual reconfiguration.
\item \texttt{<ENTRY\_PATH>.icns} --- icon near the entry file with appended \texttt{.icns} extension.
\end{itemize} \medskip
For all other entries OpenCore will try to load a volume icon and fallback to the default icon:
For all other entries OpenCore will try to load a volume icon by searching
as follows, and will fallback to the default icon otherwise:
\begin{itemize}
\tightlist
\item \texttt{.VolumeIcon.icns} file at \texttt{Preboot} volume directory for APFS (if present).
\item \texttt{.VolumeIcon.icns} file at \texttt{Preboot} root for APFS (otherwise).
\item \texttt{.VolumeIcon.icns} file at \texttt{Preboot} volume in per-volume directory
(\texttt{/System/Volumes/Preboot/\{GUID\}/} when mounted at default location within
macOS) for APFS (if present).
\item \texttt{.VolumeIcon.icns} file at \texttt{Preboot} root
(\texttt{/System/Volumes/Preboot/} when mounted at default location within macOS)
for APFS (otherwise).
\item \texttt{.VolumeIcon.icns} file at volume root for other filesystems.
\end{itemize} \medskip
\emph{Note 1}: Apple's boot picker partially supports placing a volume icon file
at the operating system's \texttt{Data} volume root (\texttt{/System/Volumes/Data/} when
mounted at default location within macOS). This approach is broken: that file is not
accessible either by OpenCanopy or by Apple's own boot picker when FaultVault 2 is
enabled, which should be most people's default choice. Therefore OpenCanopy does not
try to support it. You may place a volume icon file at \texttt{Preboot} root for
compatibility with both the Apple and OpenCanopy boot pickers, or use the \texttt{Preboot}
per-volume location as above with OpenCanopy as a preferred alternative to Apple's
existing approach. \medskip
\emph{Note 2}: Be aware that using a volume icon on any drive overrides the normal
boot picker behaviour for that drive of selecting the appropriate icon depending on
whether the drive is internal or external. \medskip
Volume icons can be set in Finder. Note, that enabling this may result in
external and internal icons to be indistinguishable.
\item \texttt{0x0002} --- \texttt{OC\_ATTR\_USE\_DISK\_LABEL\_FILE}, provides custom
rendered titles for boot entries:
\begin{itemize}

BIN
Docs/Differences/Differences.pdf
View File

Binary file not shown.

34
Docs/Differences/Differences.tex
View File

@ -1,7 +1,7 @@
\documentclass[]{article}
%DIF LATEXDIFF DIFFERENCE FILE
%DIF DEL PreviousConfiguration.tex Fri Feb 12 00:56:51 2021
%DIF ADD ../Configuration.tex Fri Feb 12 00:56:51 2021
%DIF DEL PreviousConfiguration.tex Wed Feb 3 11:12:00 2021
%DIF ADD ../Configuration.tex Fri Feb 12 10:24:39 2021
\usepackage{lmodern}
\usepackage{amssymb,amsmath}
@ -3179,17 +3179,35 @@ entry choice will update till next manual reconfiguration.
\item \texttt{<ENTRY\_PATH>.icns} --- icon near the entry file with appended \texttt{.icns} extension.
\end{itemize} \medskip
For all other entries OpenCore will try to load a volume icon and fallback to the default icon:
For all other entries OpenCore will try to load a volume icon \DIFdelbegin \DIFdel{and }\DIFdelend \DIFaddbegin \DIFadd{by searching
as follows, and will }\DIFaddend fallback to the default icon \DIFaddbegin \DIFadd{otherwise}\DIFaddend :
\begin{itemize}
\tightlist
\item \texttt{.VolumeIcon.icns} file at \texttt{Preboot} volume directory for APFS (if present).
\item \texttt{.VolumeIcon.icns} file at \texttt{Preboot} root for APFS (otherwise).
\item \texttt{.VolumeIcon.icns} file at \texttt{Preboot} volume \DIFdelbegin \DIFdel{directory }\DIFdelend \DIFaddbegin \DIFadd{in per-volume directory
(}\texttt{\DIFadd{/System/Volumes/Preboot/\{GUID\}/}} \DIFadd{when mounted at default location within
macOS) }\DIFaddend for APFS (if present).
\item \texttt{.VolumeIcon.icns} file at \texttt{Preboot} root
\DIFaddbegin \DIFadd{(}\texttt{\DIFadd{/System/Volumes/Preboot/}} \DIFadd{when mounted at default location within macOS)
}\DIFaddend for APFS (otherwise).
\item \texttt{.VolumeIcon.icns} file at volume root for other filesystems.
\end{itemize} \medskip
Volume icons can be set in Finder. Note, that enabling this may result in
external and internal icons to be indistinguishable.
\item \texttt{0x0002} --- \texttt{OC\_ATTR\_USE\_DISK\_LABEL\_FILE}, provides custom
\DIFdelbegin \DIFdel{Volume icons can be set in Finder. Note, that enabling this may result in
external and internal icons to be indistinguishable. }\DIFdelend \DIFaddbegin \emph{\DIFadd{Note 1}}\DIFadd{: Apple's boot picker partially supports placing a volume icon file
at the operating system's }\texttt{\DIFadd{Data}} \DIFadd{volume root (}\texttt{\DIFadd{/System/Volumes/Data/}} \DIFadd{when
mounted at default location within macOS). This approach is broken: that file is not
accessible either by OpenCanopy or by Apple's own boot picker when FaultVault 2 is
enabled, which should be most people's default choice. Therefore OpenCanopy does not
try to support it. You may place a volume icon file at }\texttt{\DIFadd{Preboot}} \DIFadd{root for
compatibility with both the Apple and OpenCanopy boot pickers, or use the }\texttt{\DIFadd{Preboot}}
\DIFadd{per-volume location as above with OpenCanopy as a preferred alternative to Apple's
existing approach. }\medskip
\emph{\DIFadd{Note 2}}\DIFadd{: Be aware that using a volume icon on any drive overrides the normal
boot picker behaviour for that drive of selecting the appropriate icon depending on
whether the drive is internal or external. }\medskip
\DIFaddend \item \texttt{0x0002} --- \texttt{OC\_ATTR\_USE\_DISK\_LABEL\_FILE}, provides custom
rendered titles for boot entries:
\begin{itemize}
\tightlist

BIN
Docs/Errata/Errata.pdf
View File

Binary file not shown.