aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2022-11-02Fixing broken links and formatting in App Framework pageVinod Ahuja1-7/+20
Fixing formatting and reference broken links in application framework page. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: Id155ff687a370890318817633ce1831bc5ce6389 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28098 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-10-25Adding various platforms used by aglVinod Ahuja1-1/+34
Adding the list of platforms AGL uses for different purposes. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I064d8219e13595cf6a28e8e053f835a2e98f0b2e Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28064 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-10-25Fixing the branch name in latest stable releaseVinod Ahuja1-5/+7
Fixing the branch name for the latest stable release branch. Bug-AGL: [SPEC-4590] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: If63436f9d237aa37035a1fc72d7816bb9667120c Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28063 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-10-04Fixing SSH key generation problemVinod Ahuja1-17/+15
I installed Ubuntu 22.04 and RSA protocol for ssh key pair was not working and was constantly getting permission denined key pair mismatch issues. After following openstac documentation (https://docs.openstack.org/contributors/common/setup-gerrit.html) I was quickly able to fix SSH key setup issue. Open Stack recommended to use ed25519 keys protocol as it works well in all operating system. Following that recommendation and personally experience issues with RSA key generation I have updated the documentation to ed25519. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I6209337e0056821ec9a0f28ea9aabb9d0933c53e Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28037 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-09-26Add documentation for Flutter IVI dashboard applicationshritikchouhan2-0/+78
This will add documentation to build and boot the agl-ivi-demo-platform-flutter homescreen using QEMU. Change-Id: Ieee92c3cdb0c7598f5df64ebe9d4c705c46e7e20 Signed-off-by: hritikchouhan <hritikc3961@gmail.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28029 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-09-22Improving Developer 3_Developer_GuidesVinod Ahuja3-17/+25
Worked on creating new services and applications. 1. Removed Fixme file 2. Formatted some text and numbering 3. Fixed some broken links. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: If3f9a171faff8466bd6d141f9537cd98468fadbb Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27993 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-09-16Add steps to enable navigationaakash-s451-2/+10
To enable navigation, OPENROUTE_API_KEY variable need to be set in local.conf Bug-AGL: SPEC-4543 Change-Id: I4acab227e2bbb58b25891dced4eab4fcc3be66f1 Signed-off-by: aakash-s45 <tech2aks@gmail.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28000 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-09-07Add documentation for Flutter Instrument Clusteraakash-s453-0/+118
This will add documentation to build and boot the agl-cluster-demo-platform-flutter demo image using QEMU Bug-AGL: SPEC-4543 Change-Id: I659f2d953afa76bc6fe51731258f7b3b5f747431 Signed-off-by: Aakash Solanki <tech2aks@gmail.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27969 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-09-07Fixing broken linksVinod Ahuja1-5/+5
Fixing sevral broken links pointing to yacto project documentation. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: Ice74da910a6ec7d216b55bf209eed3cc65ae2c53 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27972 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-09-07Fixing Several broken links referring to YactoVinod Ahuja1-1/+1
Fixing several broken links referring to Yacto Project Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I42a3ed35dde10e01338e5fdc0fc6ffdb33e80cab Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27971 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-09-07Fixing broken links in Developer GuidesVinod Ahuja1-9/+27
1. Fixing broken links in Developer guides -> setting up AGL SDK in step 1 2. Renaming files in command line code based on the file downloaded in step 1 3. Putting notes for changing the .sh file in different commands Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I011b958ebab8319ae5f3b519875abb389615b33c Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27957 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> ci-image-boot-test: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-09-07Updating Hardware Support PageVinod Ahuja2-106/+112
1. Fixing some typos 2. Adding latest snapshot 3. Adding source to tar and binary 4. Separating pages for supported hardware and software Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I00b80b0d6e8c37f853687860fc5d08d25490df0d Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27941 Reviewed-by: Scott Murray <scott.murray@konsulko.com> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> ci-image-boot-test: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-08-05Adding description of supported boardsVinod Ahuja1-7/+16
Adding description of supported boards and link to thier quick starting Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I39d492ebde39300136b503f87aaec7bc08632e51 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27855 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-08-05Adding participate section and other minor editsVinod Ahuja1-19/+23
1. Removing some of the repetitive bullet points from the main page. 2. Adding detail participate section to the main page 3. Fixing some formatting. 4. Removing references to the wiki page for AGL distrou and google calendar Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I82d581ca05d6e0ee824465631c4e404caf2e4f86 Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27793 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-07-27First round of updates to Hardware Support pageneedlefish_13.93.0needlefish_13.92.0needlefish/13.93.0needlefish/13.92.013.93.013.92.0Jan-Simon Moeller1-9/+1
Update the supported boards for the master branch. Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Change-Id: If3564e29519e9d45a2bca6d4e464ee16207b133e Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27795
2022-07-20Adding submitting change guidelineVinod Ahuja1-2/+2
Adding note for committer to follow submitting change guideline. Bug-AGL: SPEC-4470 Change-Id: I40f26d9ab6e4d574e39ec677caa856a38ca94888 Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27763 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-07-20Reducing Image size as discussed in SAT meetingVinod Ahuja1-1/+1
Change-Id: I686ad428a9b6e3552fcdfd7a2048aa236c6a17b6 Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27749 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
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