summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarius Vlad <marius.vlad@collabora.com>2022-05-27 15:02:48 +0300
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2022-06-10 21:14:27 +0000
commit5292e53df484555343b3f035f70e4df05e1e1a73 (patch)
tree0b24775369fcb0ab69d9ad028c8e6fd1b29bc0d8
parent849d8cce7f187067e8eb523c20cc832e4cfda96d (diff)
1_agl-compositor.md: Document how to start client shell
While that's not the way we do it AGL, let us document how to start a client shell from the compositor. Bug-AGL: SPEC-4400 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I2661686aa6d437cc789569aad8259f6aa9a45989 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27567 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
-rw-r--r--docs/5_Component_Documentation/1_agl-compositor.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/docs/5_Component_Documentation/1_agl-compositor.md b/docs/5_Component_Documentation/1_agl-compositor.md
index ef3b806..23e3a1a 100644
--- a/docs/5_Component_Documentation/1_agl-compositor.md
+++ b/docs/5_Component_Documentation/1_agl-compositor.md
@@ -76,11 +76,21 @@ seen as one and the same, and in practice, this happens on desktop
environments. For AGL, the shell client can be represented under different
forms, as well as the fact that the process management has another layer
baked-in to handle MAC (Mandatory Access Control) labels and use the
-above-mentioned Application Framework Management. These are all tightly
+above-mentioned Application Framework. These are all tightly
integrated and therefore, the AGL compositor will not automatically start the
-shell client, although there's code to handle that. One can modify the
-configuration file, add the shell client path, and the compositor will attempt
-to start it.
+shell client, although there's code to handle that.
+
+## Specifying a shell client to be started by the compositor
+
+Nevertheless, one can modify the configuration file, add the shell client path, and the
+compositor will attempt to start it.
+
+```
+[shell-client]
+command=/path/to/your/client/shell
+```
+
+
## Private extensions