Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Introduction

Table of contents

  1. Introduction
    1. Configuration Terms

Configuration Terms

  • OC config — OpenCore Configuration file in plist format named config.plist. It provides an extensible way to configure OpenCore and is structured to be separated into multiple named sections situated under the root plist dictionary. These sections may have plist array or plist dictionary types and are described in corresponding sections of this document.
  • valid keyplist key object of OC config described in this document or its future revisions. Besides explicitly described valid keys, keys starting with the # symbol (e.g. #Hello) are also considered valid keys and while they behave as comments, effectively discarding their values, they are still required to be valid plist objects. All other plist keys are not valid, and their presence results in undefined behaviour.
  • valid value — valid plist object of OC config described in this document that matches all the additional requirements in specific plist object descriptions if any.
  • invalid value — valid plist object of OC config described in this document that is of other plist type, does not conform to additional requirements found in specific plist object descriptions (e.g. value range), or missing from the corresponding collection. Invalid values are read with or without an error message as any possible value of this plist object in an undetermined manner (i.e. the values may not be same across the reboots). Whilst reading an invalid value is equivalent to reading certain defined valid values, applying incompatible values to the host system may result in undefined behaviour.
  • optional valuevalid value of OC config described in this document that reads in a certain defined manner provided in specific plist object description (instead of invalid value) when not present in OC config. All other cases of invalid value do still apply. Unless explicitly marked as optional value, any other value is required to be present and reads to invalid value if missing.
  • fatal behaviour — behaviour leading to boot termination. Implementations shall prevent the boot process from continuing until the host system is restarted. It is permitted, but not required, to execute cold reboots or to show warning messages in such cases.
  • undefined behaviour — behaviour not prescribed by this document. Implementations may take any measures including, but not limited to, measures associated with fatal behaviour, assumptions of any state or value, or disregarding any associated states or values. This is however subject to such measures not negatively impacting upon system integrity.

Table of contents