diff --git a/cloudinit/config/schemas/schema-cloud-config-v1.json b/cloudinit/config/schemas/schema-cloud-config-v1.json index 435d2ea7d14..1109d1ffcf9 100644 --- a/cloudinit/config/schemas/schema-cloud-config-v1.json +++ b/cloudinit/config/schemas/schema-cloud-config-v1.json @@ -2680,12 +2680,12 @@ "properties": { "console": { "type": "boolean", - "description": "Enable serial console. Default: ``false``.", + "description": "Enable login shell to be accessible over serial. Default: ``false``.", "default": false }, "hardware": { "type": "boolean", - "description": "Enable UART hardware. Default: ``false``.", + "description": "Enable serial port hardware. Default: ``false``.", "default": false } } diff --git a/doc/module-docs/cc_raspberry_pi/data.yaml b/doc/module-docs/cc_raspberry_pi/data.yaml index b7882bc1a95..8c72d5e99b8 100644 --- a/doc/module-docs/cc_raspberry_pi/data.yaml +++ b/doc/module-docs/cc_raspberry_pi/data.yaml @@ -11,13 +11,16 @@ cc_raspberry_pi: This example will enable the SPI and I2C interfaces on Raspberry Pi. file: cc_raspberry_pi/example1.yaml - comment: > - This example will enable the serial interface on Raspberry Pi. + This example will enable the serial console (login shell) on Raspberry Pi. + On models prior to Pi 5, enabling the console also enables the UART hardware. file: cc_raspberry_pi/example2.yaml - comment: > - This example will enable the serial interface on Raspberry Pi 5 and disable the UART hardware while enabling the console. + This example will enable the serial console on Raspberry Pi 5 + while disabling the UART hardware (only Pi 5 allows this combination). file: cc_raspberry_pi/example3.yaml - comment: > - This example will enable ssh and the UART hardware without binding it to the console. + This example will enable the UART hardware without binding it + to the serial console, allowing applications to use the port directly. file: cc_raspberry_pi/example4.yaml - comment: > This example will enable the Raspberry Pi Connect service.