summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
2022-07-13Document building isolation container imagesneedlefish_13.91.0needlefish/13.91.013.91.0Mohamed Amir1-0/+124
This commit adds a new instruction document for the Instrument Cluster target. To reduce the main build section, we split the profile description and build page. Then, add a new section as follow: |-- 0_Getting_Started | |-- 1_Quickstart | |-- 2_Building_AGL_Image | `-- 3_Build_and_Boot_guide_Profile | `-- 1_Instrument_Cluster_(IC-IVI_with_Container_isolation).md Bug-AGL: SPEC-4190 Signed-off-by: Mohamed Amir <mohamed@hhq.suzuki.co.jp> Signed-off-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com> Change-Id: Ib031f8656da5ae77454a662f765ed5f7159b8e1e Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27667 Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Naoto YAMAGUCHI <naoto.yamaguchi@aisin.co.jp>
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-31Fixed quote errors in echo expressionsamanarora98484-21/+21
Enclosed the echo expressions in double quotes (which previously had single quotes) for the following pages to prevent build errors: 1. Customizing Your Build 2. Building the AGL Image a. Building for x86 (Emulation and Hardware) b. Building for Raspberry Pi 4 c. Building for Supported Renesas Boards Signed-off-by: amanarora9848 <aman.arora9848@gmail.com> Change-Id: I18543d001e5da6fbdcf11d72236122c7e6ffdac1 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27575 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-04-13Fixed indentation error for a sub-bullet pointamanarora98481-5/+4
Formatted the point 3 in the document "Preparing Your Build Host" Signed-off-by: amanarora9848 <aman.arora9848@gmail.com> Change-Id: Id42e143305189121129f8ac940c5bf86a6d80ebf Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27370 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-03-02RCAR: Update BSP version in documentationmarlin_12.93.0marlin/12.93.012.93.0Frederic Marec1-1/+1
Following SPEC-4234 Bug-AGL: SPEC-4273 Signed-off-by: Frederic Marec <frederic.marec@iot.bzh> Change-Id: Ie15b7f056f2268c79f7c27742c26e708ab78d48e Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27231 Reviewed-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-03-013_Developer_Guides: add new app framework documentationArnaud Ferraris4-2/+591
Starting with `marlin`, the old AppFW has been phased out and replaced by a new implementation, relying mainly on standard technologies and software. This commit documents the current state of the new Application Framework so developers can create compliant applications. Bug-AGL: SPEC-4236 Signed-off-by: Arnaud Ferraris <arnaud.ferraris@collabora.com> Change-Id: I4cf52799426efbc2401b8785aaa57cc925a4968f Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27166 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-02-243_Developer_Guides/5_General_setup: Simple docs for video camera streamingMarius Vlad1-0/+94
This mostly targets rpi4 as a camera and display are rather easy to get by, but also vivid testing module which can also be used from h3ulcb. Bug-AGL: SPEC-4170 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: Id76c2a2bf5c1156de70c906c0534c36b36af30c4 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27134 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öller59-14723/+96
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-12-22Fix a spell miss of document.marlin_12.91.0marlin/12.91.012.91.0Qiu Tingting1-2/+2
Bug-AGL：SPEC-4188 Signed-off-by: Qiu Tingting <qiutt@fujitsu.com> Change-Id: I25be4702acb64be59b9d79cf5a46354c8302ea8e Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27051 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-12-06Modify document of 2_Creating_a_New_Serviceduerpei1-11/+50
Bug-AGL: SPEC-4162 Change-Id: I07f8bda958b86ec5d472e71d63ab30aa9df4c378 Signed-off-by: duerpei <duep.fnst@fujitsu.com> Change-Id: Ie0b8eae61ac6bf0e5d44756b1221576e29602102 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26952 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-11-30Update Renesas documentation following new BSPFrederic Marec1-1/+1
Bug-AGL: SPEC-4147 Signed-off-by: Frederic Marec <frederic.marec@iot.bzh> Change-Id: I54180e050e1884511eb83957be4bc82be2216e62 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26880 Reviewed-by: Naoto YAMAGUCHI <naoto.yamaguchi@aisin.co.jp> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-11-19Renesas: Add bitbake command each targetRonan Le Martret1-0/+15
Bug-AGL: SPEC-4024 Signed-off-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com> Signed-off-by: Ronan Le Martret <ronan.lemartret@iot.bzh> Change-Id: I5b4cb25b3be70040a6c206ca7b6409bc2419c971 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26731 Reviewed-by: Naoto YAMAGUCHI <naoto.yamaguchi@aisin.co.jp> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-11-19Renesas: Add Build Environment Insrument ClusterRonan Le Martret1-0/+26
Bug-AGL: SPEC-4024 Signed-off-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com> Change-Id: Ic7dcb520d48d64b4b880ec9bb767ca863f176af9 Signed-off-by: Ronan Le Martret <ronan.lemartret@iot.bzh> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26730 Reviewed-by: Naoto YAMAGUCHI <naoto.yamaguchi@aisin.co.jp> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-10-12renesas: refactoring documentationmarlin_12.90.1marlin/12.90.112.90.1Frederic Marec1-460/+425
Change title to avoid its presence twice Move some parts to troubleshooting Change numerotation Bug-AGL: SPEC-4074 Signed-off-by: Frederic Marec <frederic.marec@iot.bzh> Change-Id: I598cdabfab5ebec9230e5fd9353521897cc152d6 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26627 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
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-15Update file link for h3ulcb on masterJan-Simon Möller1-3/+3
Update the filename and add note on accelerated gfx. Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org> Change-Id: I042fb73bfeeca7235c8b281997656cd55795dc1b Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26503
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-06-07Update irc and quickstart linksJan-Simon Möller3-7/+7
We're moving to irc.libera.chat, thus change this on the doc site as well. Also update the mailinglist and contribution links. Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org> Change-Id: I3464eab8928123491542a27fc350281b6a75b45f Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26392 Reviewed-by: Walt Miner <walt@linux.com>
2021-03-22Fix branch name from jellyfish to koi in the document of koi releaselamprey_11.91.0lamprey/11.91.011.91.0Naoto YAMAGUCHI1-3/+3
When the agl developer create agl source tree of koi release using repo, they create jellyfish source tree. Because the document of koi has incorrect description for repo command example. This patch fix to this issue. Signed-off-by: Naoto YAMAGUCHI <i33399_YAMAGUCHI@aisin-aw.co.jp> Change-Id: I0b7d3fe76c38383eed291bd1c78c74bf20c998ca Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26179 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> (cherry picked from commit 43c8b7cdb0662e738ea6eb9ecfa72ca3437b2aee) Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26162
2021-03-16[Renesas] Update Renesas bsp versionFrederic Marec1-1/+1
Bug-AGL: SPEC-3804 Signed-off-by: Frederic Marec <frederic.marec@iot.bzh> Change-Id: I230f65a21fc21bccf0ff41f97b30962493c26e81 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26149 Reviewed-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com> 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-03-09Add documentation on how to add a LAVA labJan-Simon Möller1-0/+211
Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org> Change-Id: I3a70e7dcfd4e517256dff3b167139cecb0476f4f Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26139
2021-02-05Mention virtio-aarch64 machine among supported hardware.Vasyl Vavrychuk1-1/+2
Bug-AGL: SPEC-3778 Change-Id: I6bfedb55b22e484e9d00f42eb7f5feee0175b1ff Signed-off-by: Vasyl Vavrychuk <vasyl.vavrychuk@opensynergy.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25966 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-02-05Add getting started document for virtio machine.Vasyl Vavrychuk2-3/+154
Prepared it based on 5_1_x86_Emulation_and_Hardware.md file. Bug-AGL: SPEC-3778 Signed-off-by: Vasyl Vavrychuk <vasyl.vavrychuk@opensynergy.com> Change-Id: I1688b4e24a18b0d33f008085c90411723a29b76a Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25965 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-02-05README.md: Remove sudo usage.Vasyl Vavrychuk1-2/+6
It is more common to use pip without sudo. Also, no reason to use sudo with 'mkdocs serve'. Bug-AGL: SPEC-3778 Signed-off-by: Vasyl Vavrychuk <vasyl.vavrychuk@opensynergy.com> Change-Id: Ic4e2b34da98b0f036c34f253c0f0aeea150db443 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25968 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-02-03Adapt instructions for VirtualBoxJan-Simon Möller1-1/+8
This is due to https://www.virtualbox.org/ticket/19873?cversion=0&cnum_hist=4 Adapt the documentation to deal with the resolution issue. Bug-AGL: SPEC-3731 Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org> Change-Id: I6ff56593d1064d44dc5ab972d8e3475003a91f36 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25988
2021-02-03Generic updates to the documentation matching master and koiJan-Simon Möller9-68/+70
Mostly updates to the yocto links or adding the refhw. Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org> Change-Id: Ib28bd5de72e7be8b2a2605e8149143fb946a7b69 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25986
2021-02-03Fix documentation CSS styleFrederic Marec1-0/+4
Specify display for summary tag for firefox Bug-AGL: SPEC-3708 Signed-off-by: Frederic Marec <frederic.marec@iot.bzh> Change-Id: Ic290665c4ecf8e2060eb11162839b9ca6275cb3c Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25964 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-02-02Add AGL docs page to make a custom recipeThomas Walzer1-0/+0
This docs page shows how to add a custom recipe from a git-repo. It shows how to do this step by step. It was used to make the cannelloni recipe. Bug-AGL: [SPEC-3768] Signed-off-by: Thomas Walzer <thomas.walzer@reutlingen-university.de> Change-Id: I306786bfc42aa64eb256259f61d0e402e23c37a2 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25907 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-02-02Changed the folder names of pictures to images and changed the paths in the ↵Thomas Walzer13-9/+9
md files. Signed-off-by: Thomas Walzer <thomas.walzer@reutlingen-university.de> Change-Id: Idd44284f082c427ee5f6245465009c9a89539922 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25901 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-02-02Added Create a Custom RecipeThomas Walzer2-0/+49
Signed-off-by: Thomas Walzer <thomas.walzer@reutlingen-university.de> Change-Id: Ice9a0c4bf385e4a2af5c0e88a1c0d18a1c6ceb74 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25899 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-01-26Document AGL Reference Hardwarekoi_10.93.0koi/10.93.010.93.0Scott Murray1-1/+26
Add AGL Reference Hardware configuration to the Renesas board documentation. Bug-AGL: SPEC-3708 Signed-off-by: Scott Murray <scott.murray@konsulko.com> Change-Id: I48c852ec2ee880cae121a7d3368f5a127bcf2d9b Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25957 Reviewed-by: Fr�d�ric Marec <frederic.marec@iot.bzh> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2021-01-26Fix formatting issues in Renesas board markdownScott Murray1-402/+320
Changes: - python-markdown is particular about indentation being 4 spaces for lists, fix various indentation so that the generated page has properly numbered lists and indentation levels. - Replace some remaining XML markup that was breaking the page rendering with code blocks. This fixes the U-Boot output examples. - Simplify the indentation in section 11 by using section headers for the multimedia and ICCOM information instead of a list. This avoids a lot of extra indentation in the markdown and wastes less horizontal space on the generated page. - Add a couple more elinux.org links where it seemed appropriate. - Tweak wording in a couple of spots to read better. Bug-AGL: SPEC-3708 Signed-off-by: Scott Murray <scott.murray@konsulko.com> Change-Id: I6b643804b11ee7dae11a7a5569abe57337270f86 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25956 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-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 Moeller23-0/+71
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
2020-12-07Removed redundant directory in APIs and Serviceskoi_10.92.0koi_10.91.0koi/10.92.0koi/10.91.010.92.010.91.0Shankho Boron Ghosh1-0/+0
Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: Id7ac2ae56db00325df1782d9ec0ab82caebfb0b2 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25668 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>