aboutsummaryrefslogtreecommitdiffstats
path: root/docs/5_Component_Documentation
AgeCommit message (Collapse)AuthorFilesLines
2022-11-08Fixing the index numberingVinod Ahuja15-2222/+0
Fixing the index numbering for all documentation Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I96b482a3ab598f0739c692e301de66c0553ba0e4 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28118 Reviewed-by: Walt Miner <wminer@linuxfoundation.org> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-09-16agl-compositor.md: Add some notes about v2 and v3 protocol updateMarius Vlad1-0/+53
This includes some notes which might be useful for people to reason about why these updates are happening. Bug-AGL: SPEC-4528 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I526af1b1b12f9bfbeae106d6ec4a436de172d318 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27999 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-06-101_agl-compositor.md: Document how to start client shellMarius Vlad1-4/+14
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>
2022-06-101_agl-compositor.md: We're no longer using SMACKMarius Vlad1-7/+5
Removes any mention of SMACK and use a more generic term. Also, s/AFM/AppFW/ Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I18dd7dd4f76fb4cba9cd5be55510f08ec3c36b8e Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27566 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-06-105_Component_Documentation: Fix Application Framework linksMarius Vlad2-2/+2
Use relative links to link correctly to AppFW. Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: Iefefc031d77b54a09f2cdfcead5e1dd13e3b7170 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27565 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-05-24Fixed internal link erroramanarora98481-1/+1
Fixed the internal hyperlink for 'Pipewire & Wireplumber' page present on the 'Components under development' within AGL page. Signed-off-by: amanarora9848 <aman.arora9848@gmail.com> Change-Id: Icf36a96c4a55638956185890ce8f6418d95a59d5 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27520 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-02-170_AGL_components.md: Clear up missing filesMarius Vlad1-6/+1
Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I08e32b560fcd292f923a54c676e2c22937dd4e9d Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27133 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-02-02Update to documentation before Marlinmarlin_12.92.0marlin/12.92.012.92.0Jan-Simon Möller5-257/+0
This is mostly a cleanup before the Magic Marlin Release. We do have the Application Framework chapter rewrite pending. Bug-AGL: SPEC-4236 Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org> Change-Id: I7e1f39667b4db417497b1d0c84065c173fa18439 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27097
2021-10-120_AGL_components: Provide some structure to the AGL developed compomentsMarius Vlad1-10/+28
Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I9a50754bfeb19b74e5b31a58b55f1ff3f4f766ce Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26669 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-10-12docs/5_Component_Documentation/1_agl-compositor: Slash headersMarius Vlad1-2/+2
mkdocs doesn't generate links for Header 3 types, so use Header 2 to have more links available, in case these might be needed. Change-Id: I33c5e0bf5bcd74835f49ca7cd599753335b015ac Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26668 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-10-12docs/5_Component_Documentation/1_agl-compositor: Update agl-compositor docsMarius Vlad1-0/+58
Include some examples on how to associate touch input devices with multiple outputs. Bug-AGL: SPEC-3836 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: Ib71bf8db8e349d8a4a2caf52e450e8a70bbf1f04 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26667 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-10-12docs: add a design document for the "IC sound manager" setupGeorge Kiagiadakis4-0/+120
Bug-AGL: SPEC-4027 Signed-off-by: George Kiagiadakis <george.kiagiadakis@collabora.com> Change-Id: I3059c81f13c359e7af10089f102e811c94814e99 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26663 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-10-12RBA docs: Update step to generate .json from .rba fileAnusha Gugale1-1/+21
Signed-off-by: Anusha Gugale <external.agogale@jp.adit-jv.com> Change-Id: Id8a966014b58d9369f50bca7144c40f69b79939f Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26672 Reviewed-by: Naohiro Nishiguchi <nnishiguchi@jp.adit-jv.com> Reviewed-by: Kenji Hosokawa <khosokawa@jp.adit-jv.com> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-08-05Added RBA tool documentationAnusha Gugale3-3/+1183
Syntax of .rba file Bug-AGL: SPEC-3947 Signed-off-by: Anusha Gugale <external.agogale@jp.adit-jv.com> Change-Id: Ibac6b1a38a1ed2a149cf4e45fad180d427d8e174 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26541 Reviewed-by: Kenji Hosokawa <khosokawa@jp.adit-jv.com> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Naohiro Nishiguchi <nnishiguchi@jp.adit-jv.com> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-07-09More docs in 7_pyagl.mdEdi Feschiyan1-40/+143
Adding the rest of PyAGL documentation for mkdocs, this commit should be a relatively complete documentation for pyagl Bug-AGL: SPEC-3949 Signed-off-by: Edi Feschiyan <edi.feschiyan@konsulko.com> Change-Id: I631ca03a57faac0b6285193d7f7d877dfed4374d Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26489 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-06-24Add initial DRM Lease Manager documentationmarlin_12.90.0marlin/12.90.012.90.0Damian Hobson-Garcia1-2/+103
AGL-BUG: SPEC-3948 Signed-off-by: Damian Hobson-Garcia <dhobsong@igel.co.jp> Change-Id: Icdcb1e63bd5d4b456f81a4b495e10e97dd3d42ef Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26450 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-06-23docs: add basic pipewire/wireplumber documentationGeorge Kiagiadakis1-3/+155
Bug-AGL: SPEC-3950 Signed-off-by: George Kiagiadakis <george.kiagiadakis@collabora.com> Change-Id: Iaf68d263114c34944eca28507c8521a9c8d5d51d Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26448 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-06-11update test sample command for pyagl test doclamprey_11.92.0lamprey/11.92.011.92.0liuyahui1-1/+1
Bug-AGL: SPEC-3973 Signed-off-by: liuyahui <liuyh.fnst@fujitsu.com> Change-Id: Ifcafa2a8fb30696410af15b81b6022756fa736b4 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26420 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-06-07Adding preliminary pyagl documentationEdi Feschiyan1-2/+142
Adding first bits of official pyagl documentation Bug-AGL: SPEC-3949 Signed-off-by: Edi Feschiyan <edi.feschiyan@konsulko.com> Change-Id: I0382ebb6c32ca2021d050e64c453ed970eab7a6d Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26391 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-03-15docs/2_waltham-receiver_waltham-transmitter: Added waltham documentationMarius Vlad1-2/+91
Bug-AGL: SPEC-3777 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I022c24b18b247df97f0c5781545e1ffb06656e3e Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26137 Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-03-151_agl-compositor: Mention agl-shell-app-id for migrating appsMarius Vlad1-0/+11
Besides using the agl-shell-desktop protocol one can use agl-shell-app-id to migrate surfaces to other local, or remote outputs. Bug-AGL: SPEC-3820 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: Ifdb5853a9a3eaf9dc041d68596c353548437c64b Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26136 Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-01-221_agl-compositor.md: Added initial docs for agl-compositorMarius Vlad3-2/+363
Contains some project history, and some Wayland introduction. Goes a bit explaining the private extensions, the toolkit platforms supported and some explanation of policy engines and policies. Some particularities to the agl-compositor been described as well. Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I444144dba024643c0fe639bff2a11ca8f77df8c4 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25958 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-01-20Add a category for agl-compositor and rba documentationJan-Simon Moeller9-0/+70
Create a home for docs of compositor, rba and pipewire/wireplumber. Also add a .gitignore file. Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Change-Id: Id1f9812d0f4db83cb72bf03987dc95d754e00725 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25913