systemd-serialgetty: add comments explaining use

Add some comments to clarify exactly what this recipe is for.

(From OE-Core rev: bbaafe11189b4b14ab84576e5eddd709b7f0ef1b)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 6 insertions, 1 deletions

diff --git a/meta/recipes-core/systemd/systemd-serialgetty.bb b/meta/recipes-core/systemd/systemd-serialgetty.bb
index 9035b8c335..7b525b10f0 100644
--- a/meta/recipes-core/systemd/systemd-serialgetty.bb
+++ b/meta/recipes-core/systemd/systemd-serialgetty.bb
@@ -1,8 +1,13 @@
-SUMMARY = "Serial terminal support for systemd"
+SUMMARY = "Serial terminal support for systemd (using SERIAL_CONSOLES)"
 HOMEPAGE = "https://www.freedesktop.org/wiki/Software/systemd/"
 LICENSE = "GPL-2.0-or-later"
 LIC_FILES_CHKSUM = "file://${COREBASE}/meta/files/common-licenses/GPL-2.0-only;md5=801f80980d171dd6425610833a22dbe6"
 
+# Note that this recipe explicitly creates a serial-getty@ service for every tty
+# in SERIAL_CONSOLES. This is typically not always needed with systemd as it
+# will probe at boot and generate getty instances for any active consoles as
+# required.  This recipe (enabled via disabling serial-getty-generator in systemd)
+# should only be used if the generator is not appropriate.
 
 SERIAL_CONSOLES ?= "115200;ttyS0"
 SERIAL_TERM ?= "linux"