summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
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-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-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 Moeller22-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
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>
2020-12-07Link FixShankho Boron Ghosh1-4/+2
Corrected internal link in documentation homepage. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: Id73010b73d4fb56824642b510e9d4434466b194d Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25667 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-12-07Added Using CMAKE Applications Module in Developer GuidesShankho Boron Ghosh6-0/+835
Revised and added Using CMAKE Applications Module as a part of Developer Guides. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I2cf8e06d3f4c43e748476eaddcb950417f5f0eba Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25666 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-12-07Added AFB Helper Guide in Developer GuidesShankho Boron Ghosh8-0/+1643
Revised and added AFB Helper Guide as a part of Developer Guides. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I3df9265ae0570e987d80bc4bd2d3d14e7743b26a Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25665 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-12-07Added AGL Application Framework - Privileges ManagementShankho Boron Ghosh2-0/+8
Meta refreshed AppFW_Priveleges_Management to https://iot.bzh/download/public/2016/appfw/03-AGL-AppFW-Privileges-Management.pdf Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I27601c96a344900a6db3229f3144f0089adc4c20 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25664 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-12-07Added Application Framework Binder in Developer GuidesShankho Boron Ghosh17-0/+7502
Revised and added Application Framework Binder as a part of Developer Guides. v2 : Corrected typo : MACRO -> MACROS Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I7a6d6206f69ed44a18011c81f475ce5eac306a33 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25663 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-12-07Added Application Framework in Developer GuidesShankho Boron Ghosh11-0/+3296
Revised and added Application Framework as a part of Developer Guides. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I81c08edf722b3039c617c6bf50ae6cc9907a6116 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25662 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-12-07Added AGL Layers in Developer GuidesShankho Boron Ghosh5-179/+166
Revised and added AGL Layers as a part of Developer Guides. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: Ie66bd8bfd89d129c7fc49c20a83c331e069e4a46 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25661 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-12-04Renesas: Update package download urlFrederic Marec1-4/+4
Add note to prevent renaming Bug-AGL: SPEC-3633 Signed-off-by: Frederic Marec <frederic.marec@iot.bzh> Change-Id: I2db6734aeefdee5bbef2b95c576de6d6bebd3d2c Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25718 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-12-02Added Application guidesShankho Boron Ghosh1-0/+544
Revised Developer Guides with tutorial on creating a new application from scratch. v2 : Removed trailing whitespaces. v3 : Corrected Typo. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I5319932b10a882b65ba2bb75828bb2fc6d313b88 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25660 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-12-02Added SDK & Service guidesShankho Boron Ghosh2-0/+523
Revised Developer Guides with tutorials on installing the SDK and creating a new service from scratch. v2 : Removed trailing whitespaces. v3 : Removed duplicated output. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I5a1854f54f476ac69498956e4dd22fa4b6e85eee Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25642 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-11-23Updated Quickstart with ARM32 & AARCH64Shankho Boron Ghosh1-11/+179
Added instructions for ARM 32 bit (Emulation and BeagleBone Enhanced) and AARCH64 - ARM 64bit (Emulation). v2 : Corrected path discrepancy. v3 : Corrected qemu-run command. v4 : Nested RPi4 & Rcar under AARCH 64. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I7a031138091620568798568921305c43c00e219b Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25623 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-11-23Added Architecture Guide Overview & SpecificationShankho Boron Ghosh4-3/+56
Rewrote Architecture Guide Overview and meta-refreshed specification to refer https://www.automotivelinux.org/wp-content/uploads/sites/4/2017/08/agl_spec_v1_280515.pdf v2 : Corrected commit-msg spelling error. v3 : Removed trailing whitespaces. v4 : Removed swap file and added use cases. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: Ie9f8f88f4ce363563078ebcc0fafedfb0cdb10fe Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25617 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-11-20General Guidelines : DCO adherenceShankho Boron Ghosh1-1/+2
Mentioned DCO in legal stuff section. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: Ifbbae95196ce6db1b7d3ad32f9c46ac4c727dacd Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25593 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-11-18FIX : Internal LinksShankho Boron Ghosh1-4/+2
Minor fix of internal links. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I689193817da24c9bfb8fcea9fd6b497cda58ab76 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25588 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-11-18Contribution Checklist : Minor NestingShankho Boron Ghosh1-6/+6
Indentation added for proper nesting of checklist points. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I47dfc52805b1aff4cfdf3dee0287fffafbbe0a03 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25587 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-11-18Revision of Architecture GuidesShankho Boron Ghosh48-3096/+2824
v1: Introduction : Skeleton file of Build Process [WIP]. Security Blueprint : Multiple markdowns appended into single markdown. v2: Security Blueprint : 4_Kernel.md - Fixed Internal Link. Annexes.md - Uniform markdown Title. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I1ab478348a05464612d67f0e8a4570bda309022d Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25586 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-11-16Added Contribution ChecklistShankho Boron Ghosh2-3/+62
Added comprehensive tasklist as a guideline for contributions in How To Contribute section. Also, minor fixup of API reference : 0_api-introduction. v2: Added item : Is a backport to a release branch required ? Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I122f2093bd8360be4082497e0cadb67ca67d6d4e Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25580 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-11-16Updated Quickstart qemu launch instructions.Shankho Boron Ghosh1-3/+3
Added -vga virtio to qemux86 doc. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I116fc5ac529d1ec0564f6a5f1e269a86837bb0c0 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25581 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-11-13Added APIs introductionShankho Boron Ghosh1-0/+49
Adding old api introduction page. v2: Adding only 4.1 : Introduction Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: Ibdabddccd73c1230c1b78c71c2cea4c5542b4a9b Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25558 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-11-11Added [in-progress] Developer GuidesShankho Boron Ghosh50-995/+1604
Updated mkdocs.yml, README.md. Text wrap markdowns at 80. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I2d7b43cb870e97786d3eb101c60a2071cc50f0be Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25498 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-10-23Renesas: Fix renesas documentationFrederic Marec1-470/+774
Difference was done between old and new documentation Keeping useful information from the old version Adding new changes from the new one v2 (jsmoeller): keep in sync with other machines Bug-AGL: SPEC-3666 Signed-off-by: Frederic Marec <frederic.marec@iot.bzh> Change-Id: Ifa87dfa5ead453b0b994905e80989c6efae726db Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25471 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-10-23Added Contribution GuideShankho Boron Ghosh16-47/+892
Exhaustive Contribution Guide. Removed Trailing Whitespaces. Updated index.md. Abandoned accidental commits 25474, 25474 and uploading a new patchset. Corrected code renderings. v2 (jsmoeller): Update contribution subchapters Bug-AGL: SPEC-3633 Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: Ia808adc0208052f0591396860ac776e34070d279 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25473 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-10-14rewrote quickstart, build-processgrowupboron342-31950/+1714
Revamped and updated documentation to install and build AGL images. (removed whitespaces, added contribution guide, corrected rcar-gen3 section 7, added aglsetup.h flags to hardware support, some minor changes) Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: Iedb6c7dc1661f4bc58b5f25ea5d188778c7ff908 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25407 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2020-09-11Simplified doc-site generationjellyfish_9.99.4jellyfish/9.99.49.99.4growupboron326-0/+36514
Updated theme to windmill Using Mkdocs static site generator Deployed on readthedocs Signed-off-by: growupboron <shankhoghosh123@gmail.com> Change-Id: If62eaaea1855c91b64f687900f54eba6bc1caee8 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25236 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>