summaryrefslogtreecommitdiffstats
path: root/docs/0_Getting_Started
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-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-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-02-02Update to documentation before Marlinmarlin_12.92.0marlin/12.92.012.92.0Jan-Simon Möller3-87/+92
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-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-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-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-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öller6-42/+43
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-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>
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-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-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-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-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 Ghosh2-11/+3
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-processgrowupboron49-2662/+1459
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.4growupboron32-0/+3145
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>