mirror of
https://github.com/acidanthera/OpenCorePkg.git
synced 2025-12-08 19:25:01 +00:00
Docs/Comments: Consistent use of Note: instead of NB
This commit is contained in:
parent
573c2d590a
commit
01b457fe81
@ -138,7 +138,7 @@ If providing just one file, name it `Shell.icns` if the theming of the icon is g
|
||||
- **Shell** - Any shell-style tool
|
||||
- **UEFIShell:Shell** - EDK II UEFI Shell
|
||||
- As an example of how flavours work: **UEFIShell:Shell** will try `UEFIShell.icns`, then `Shell.icns` (and then, by OC default behaviour, `Tool.icns`, then `HardDrive.icns`)
|
||||
- _**NB**: Including **UEFIShell** anywhere in the flavour triggers picker audio-assist for "UEFI Shell"_
|
||||
- _**Note**: Including **UEFIShell** anywhere in the flavour triggers picker audio-assist for "UEFI Shell"_
|
||||
- **OpenShell:UEFIShell:Shell** - Themed specifically for OpenCore OpenShell (which is a variant of the EDK II UEFI Shell)
|
||||
- This is the recommended flavour to use for `OpenShell.efi`, as is done in the sample config files
|
||||
- Although this is the recommended *flavour*, icon artists are not required to provide this icon file, since this flavour will automatically find and use `Shell.icns` or `UEFIShell.icns` anyway
|
||||
@ -155,11 +155,11 @@ If providing `NVRAMTool.icns`, it should be themed so that it could be applied t
|
||||
- **ResetNVRAM:NVRAMTool** - Reset NVRAM tool (`ResetNVRAM.icns`)
|
||||
- This is the recommended flavour, used for the entry created by the `ResetNvramEntry.efi` driver.
|
||||
- As another example of how flavours work: **ResetNVRAM:NVRAMTool** will look for `ResetNVRAM.icns`, then `NVRAMTool.icns` (and then, by OC default behaviour, `Tool.icns` then `HardDrive.icns`)
|
||||
- **NB**: Including **ResetNVRAM** anywhere in a user flavour triggers picker audio-assist and builtin label support for "Reset NVRAM"
|
||||
- **Note**: Including **ResetNVRAM** anywhere in a user flavour triggers picker audio-assist and builtin label support for "Reset NVRAM"
|
||||
- **ToggleSIP:NVRAMTool** - Icon themed for Toggle SIP tool (`ToggleSIP.icns`)
|
||||
- **ToggleSIP_Enabled:ToggleSIP:NVRAMTool** - Icon themed for Toggle SIP tool when SIP is enabled (system is protected)
|
||||
- **ToggleSIP_Disabled:ToggleSIP:NVRAMTool** - Icon themed for Toggle SIP tool when SIP is disabled (system is unprotected)
|
||||
- **NB**: Including **ToggleSIP_Enabled** or **ToggleSIP_Disabled** anywhere in a user flavour triggers picker audio-assist and builtin label support for the two states of the Toggle SIP menu entry
|
||||
- **Note**: Including **ToggleSIP_Enabled** or **ToggleSIP_Disabled** anywhere in a user flavour triggers picker audio-assist and builtin label support for the two states of the Toggle SIP menu entry
|
||||
|
||||
### Other Tools
|
||||
|
||||
|
||||
@ -1837,7 +1837,7 @@ OcImageLoaderLoad (
|
||||
include spaces, and '\' can be used within quoted or unquoted values to escape any
|
||||
character (including space and '"').
|
||||
|
||||
NB Var names and values are left as pointers to within the original raw LoadOptions
|
||||
Note: Var names and values are left as pointers to within the original raw LoadOptions
|
||||
string, which may be modified during processing.
|
||||
|
||||
@param[in] LoadedImage Loaded image handle.
|
||||
@ -1867,7 +1867,7 @@ OcParseLoadOptions (
|
||||
character (including space and double quote).
|
||||
Comments (if any) run from hash symbol to end of same line.
|
||||
|
||||
NB Var names and values are left as pointers to within the raw string, which may
|
||||
Note: Var names and values are left as pointers to within the raw string, which may
|
||||
be modified during processing.
|
||||
|
||||
@param[in] StrVars Raw var string.
|
||||
|
||||
@ -308,7 +308,7 @@ OcEnsureDirectoryFile (
|
||||
/**
|
||||
Process directory item.
|
||||
|
||||
NB Successful processing must return EFI_SUCCESS or EFI_NOT_FOUND, or further
|
||||
Note: Successful processing must return EFI_SUCCESS or EFI_NOT_FOUND, or further
|
||||
processing will be aborted.
|
||||
|
||||
Return EFI_NOT_FOUND to continue processing but act if no file found.
|
||||
|
||||
@ -24,7 +24,7 @@
|
||||
*
|
||||
* These are meant to identify the CPU's marketing name - an
|
||||
* application can map these to (possibly) localized strings.
|
||||
* NB: the encodings of the CPU families are intentionally arbitrary.
|
||||
* Note: the encodings of the CPU families are intentionally arbitrary.
|
||||
* There is no ordering, and you should never try to deduce whether
|
||||
* or not some feature is available based on the family.
|
||||
* Use feature flags (eg, hw.optional.altivec) to test for optional
|
||||
|
||||
@ -20,7 +20,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
// we define SMC_MAKE_IDENTIFIER to produce Little Endian keys in UEFI (EFIAPI),
|
||||
// and Big Endian keys in all other places.
|
||||
//
|
||||
// NB: This code assumes Little Endian host byte order, which so far is the
|
||||
// Note: This code assumes Little Endian host byte order, which so far is the
|
||||
// only supported byte order in UEFI.
|
||||
//
|
||||
#ifdef EFIAPI
|
||||
|
||||
@ -52,7 +52,7 @@ Lbcopy:
|
||||
; void *memcpy(void *dst, const void *src, size_t len)
|
||||
; void *memmove(void *dst, const void *src, size_t len)
|
||||
;
|
||||
; NB: These need to be 32 bytes from bcopy().
|
||||
; Note: These need to be 32 bytes from bcopy().
|
||||
;------------------------------------------------------------------------------
|
||||
align 32
|
||||
Lmemcpy:
|
||||
|
||||
@ -320,7 +320,7 @@ GetPickerKeyInfo (
|
||||
}
|
||||
|
||||
//
|
||||
// NB As historically SHIFT handling here is considered a 'hotkey':
|
||||
// Note: As historically SHIFT handling here is considered a 'hotkey':
|
||||
// it's original reason for being here is to fix difficulties in
|
||||
// detecting this and other hotkey modifiers during no-picker boot.
|
||||
//
|
||||
@ -792,7 +792,7 @@ OcInitHotKeys (
|
||||
}
|
||||
|
||||
//
|
||||
// NB Raw AKMA is also still used for HotKeys, since we really do need
|
||||
// Note: Raw AKMA is also still used for HotKeys, since we really do need
|
||||
// three different types of keys response for fluent UI behaviour.
|
||||
//
|
||||
|
||||
|
||||
@ -87,7 +87,7 @@ typedef enum ENTRY_PARSE_STATE_ {
|
||||
// First match, therefore Ubuntu should come after similar variants,
|
||||
// and probably very short strings should come last in case they
|
||||
// occur elsewhere in another kernel version string.
|
||||
// NB: Should be kept in sync with Flavours.md.
|
||||
// Note: Should be kept in sync with Flavours.md.
|
||||
//
|
||||
STATIC
|
||||
CHAR8 *
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user