StealthOS/subiquity
StealthOS
/
subiquity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use true/false instead of yes/no for bools 

Before, the reference documentation was inconsistent with boolean
values. It sometimes used true/false and other times yes/no.

This changes makes it so that the reference documentation is
consistently using true/false.
This commit is contained in:
Andreas Lindhé 2023-07-12 13:41:12 +02:00
parent 5af40f0b28
commit d604a2156f
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
documentation/autoinstall-reference.md
View File

@ -84,7 +84,7 @@ The mapping contains keys:
#### update #### update
**type:** boolean **type:** boolean
**default:** `no` **default:** `false`
Whether to update or not. Whether to update or not.
@ -166,7 +166,7 @@ network:
version: 2 version: 2
ethernets: ethernets:
enp0s31f6: enp0s31f6:
dhcp6: yes dhcp6: true
``` ```
Note that because of a bug, the version of Subiquity released with 20.04 GA forces you to write this with an extra `network:` key like so: Note that because of a bug, the version of Subiquity released with 20.04 GA forces you to write this with an extra `network:` key like so:
@ -177,7 +177,7 @@ network:
version: 2 version: 2
ethernets: ethernets:
enp0s31f6: enp0s31f6:
dhcp6: yes dhcp6: true
``` ```
Later versions support this syntax too for compatibility but if you can assume a newer version you should use the former. Later versions support this syntax too for compatibility but if you can assume a newer version you should use the former.
@ -310,7 +310,7 @@ storage:
layout: layout:
name: disk name: disk
match: match:
ssd: yes ssd: true
``` ```
(you can just say "`match: {}`" to match an arbitrary disk) (you can just say "`match: {}`" to match an arbitrary disk)
@ -388,10 +388,10 @@ A match spec supports the following keys:
* `id_path: foo`: matches a disk where ID_PATH=foo in udev, supporting globbing * `id_path: foo`: matches a disk where ID_PATH=foo in udev, supporting globbing
* `devpath: foo`: matches a disk where DEVPATH=foo in udev, supporting globbing * `devpath: foo`: matches a disk where DEVPATH=foo in udev, supporting globbing
* `serial: foo`: matches a disk where ID_SERIAL=foo in udev, supporting globbing (the globbing support distinguishes this from specifying serial: foo directly in the disk action) * `serial: foo`: matches a disk where ID_SERIAL=foo in udev, supporting globbing (the globbing support distinguishes this from specifying serial: foo directly in the disk action)
* `ssd: yes|no`: matches a disk that is or is not an SSD (vs a rotating drive) * `ssd: true|false`: matches a disk that is or is not an SSD (vs a rotating drive)
* `size: largest|smallest`: take the largest or smallest disk rather than an arbitrary one if there are multiple matches (support for `smallest` added in version 20.06.1) * `size: largest|smallest`: take the largest or smallest disk rather than an arbitrary one if there are multiple matches (support for `smallest` added in version 20.06.1)
A special sort of key is `install-media: yes`, which will take the disk the installer was loaded from (the `ssd` and `size` selectors will never return this disk). If installing to the install media, care obviously needs to be take to not overwrite the installer itself! A special sort of key is `install-media: true`, which will take the disk the installer was loaded from (the `ssd` and `size` selectors will never return this disk). If installing to the install media, care obviously needs to be take to not overwrite the installer itself!
So for example, to match an arbitrary disk it is simply: So for example, to match an arbitrary disk it is simply:
@ -406,7 +406,7 @@ To match the largest SSD:
- type: disk - type: disk
id: big-fast-disk id: big-fast-disk
match: match:
ssd: yes ssd: true
size: largest size: largest
``` ```