docs: CONFIG.md: Change remaining 'root' mentions to 'argument'

This commit is contained in:
mintsuki
2024-08-02 19:00:29 +02:00
parent f848eb4cb9
commit 4404281f78

View File

@@ -165,10 +165,10 @@ A resource can be one of the following:
* `boot` - If booted off PXE this is an alias of `tftp`. Else the `argument` is the 1-based decimal value representing the partition on the boot drive (values of 5+ for MBR logical partitions). If omitted, the partition containing the configuration file on the boot drive is used. For example: `boot(2):/...` will use partition 2 of the boot drive and `boot():/...` will use the partition containing the config file on the boot drive.
* `hdd` - Hard disk drives. The `argument` takes the form of `drive:partition`; for example: `hdd(3:1):/...` would use hard drive 3, partition 1. Partitions and drives are both 1-based (partition values of 5+ for MBR logical partitions). Omitting the partition is possible; for example: `hdd(2:):/...`. Omitting the partition will access the entire volume instead of a specific partition (useful for unpartitioned media).
* `odd` - Optical disk drives (CDs/DVDs/...). The `argument` takes the form of `drive:partition`; for example: `odd(3:1):/...` would use optical drive 3, partition 1. Partitions and drives are both 1-based (partition values of 5+ for MBR logical partitions). Omitting the partition is possible; for example: `odd(2:):/...`. Omitting the partition will access the entire volume instead of a specific partition (useful for unpartitioned media, which is often the case for optical media).
* `guid` - The `root` takes the form of a GUID/UUID, such as `guid(736b5698-5ae1-4dff-be2c-ef8f44a61c52):/...`. The GUID is that of either a filesystem, when available, or a GPT partition GUID, when using GPT, in a unified namespace.
* `guid` - The `argument` takes the form of a GUID/UUID, such as `guid(736b5698-5ae1-4dff-be2c-ef8f44a61c52):/...`. The GUID is that of either a filesystem, when available, or a GPT partition GUID, when using GPT, in a unified namespace.
* `uuid` - Alias of `guid`.
* `fslabel` - The `argument` is the name of the filesystem label of a partition.
* `tftp` - The `root` is the IP address of the tftp server to load the file from. If the root is left empty (`tftp():/...`) the file will be loaded from the server Limine booted from. This resource is only available when booting off PXE.
* `tftp` - The `argument` is the IP address of the tftp server to load the file from. If the argument is left empty (`tftp():/...`) the file will be loaded from the server Limine booted from. This resource is only available when booting off PXE.
A path can optionally be suffixed with a blake2b hash for the referenced file,
by appending a pound character (`#`) followed by the blake2b hash.