AGL/documentation.git
3 years agoMention virtio-aarch64 machine among supported hardware. 66/25966/6
Vasyl Vavrychuk [Tue, 26 Jan 2021 14:44:27 +0000 (16:44 +0200)]
Mention virtio-aarch64 machine among supported hardware.

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>
3 years agoAdd getting started document for virtio machine. 65/25965/6
Vasyl Vavrychuk [Tue, 26 Jan 2021 14:43:27 +0000 (16:43 +0200)]
Add getting started document for virtio machine.

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>
3 years agoREADME.md: Remove sudo usage. 68/25968/5
Vasyl Vavrychuk [Tue, 26 Jan 2021 01:23:52 +0000 (03:23 +0200)]
README.md: Remove sudo usage.

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>
3 years agoAdapt instructions for VirtualBox 88/25988/2
Jan-Simon Möller [Tue, 2 Feb 2021 17:51:39 +0000 (18:51 +0100)]
Adapt instructions for VirtualBox

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

3 years agoGeneric updates to the documentation matching master and koi 86/25986/2
Jan-Simon Möller [Tue, 2 Feb 2021 17:30:26 +0000 (18:30 +0100)]
Generic updates to the documentation matching master and koi

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

3 years agoFix documentation CSS style 64/25964/2
Frederic Marec [Tue, 26 Jan 2021 13:33:44 +0000 (14:33 +0100)]
Fix documentation CSS style

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>
3 years agoAdd AGL docs page to make a custom recipe 07/25907/2
Thomas Walzer [Wed, 13 Jan 2021 18:24:52 +0000 (19:24 +0100)]
Add AGL docs page to make a custom recipe

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>
3 years agoChanged the folder names of pictures to images and changed the paths in the md files. 01/25901/2
Thomas Walzer [Wed, 13 Jan 2021 12:00:47 +0000 (13:00 +0100)]
Changed the folder names of pictures to images and changed the paths in the 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>
3 years agoAdded Create a Custom Recipe 99/25899/2
Thomas Walzer [Wed, 13 Jan 2021 11:45:36 +0000 (12:45 +0100)]
Added Create a Custom Recipe

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>
3 years agoDocument AGL Reference Hardware 57/25957/2 10.93.0 koi/10.93.0 koi_10.93.0
Scott Murray [Thu, 21 Jan 2021 19:43:43 +0000 (14:43 -0500)]
Document AGL Reference Hardware

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>
3 years agoFix formatting issues in Renesas board markdown 56/25956/2
Scott Murray [Thu, 21 Jan 2021 19:09:47 +0000 (14:09 -0500)]
Fix formatting issues in Renesas board markdown

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>
3 years ago1_agl-compositor.md: Added initial docs for agl-compositor 58/25958/2
Marius Vlad [Thu, 21 Jan 2021 11:58:26 +0000 (13:58 +0200)]
1_agl-compositor.md: Added initial docs for agl-compositor

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>
3 years agoAdd a category for agl-compositor and rba documentation 13/25913/3
Jan-Simon Moeller [Thu, 14 Jan 2021 17:18:25 +0000 (18:18 +0100)]
Add a category for agl-compositor and rba documentation

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

3 years agoRemoved redundant directory in APIs and Services 68/25668/2 10.91.0 10.92.0 koi/10.91.0 koi/10.92.0 koi_10.91.0 koi_10.92.0
Shankho Boron Ghosh [Sun, 29 Nov 2020 23:39:36 +0000 (05:09 +0530)]
Removed redundant directory in APIs and Services

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>
3 years agoLink Fix 67/25667/3
Shankho Boron Ghosh [Sun, 29 Nov 2020 23:08:44 +0000 (04:38 +0530)]
Link Fix

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>
3 years agoAdded Using CMAKE Applications Module in Developer Guides 66/25666/3
Shankho Boron Ghosh [Sun, 29 Nov 2020 23:01:25 +0000 (04:31 +0530)]
Added Using CMAKE Applications Module in Developer Guides

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>
3 years agoAdded AFB Helper Guide in Developer Guides 65/25665/3
Shankho Boron Ghosh [Sun, 29 Nov 2020 22:14:47 +0000 (03:44 +0530)]
Added AFB Helper Guide in Developer Guides

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>
3 years agoAdded AGL Application Framework - Privileges Management 64/25664/3
Shankho Boron Ghosh [Sun, 29 Nov 2020 21:38:49 +0000 (03:08 +0530)]
Added AGL Application Framework - Privileges Management

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>
3 years agoAdded Application Framework Binder in Developer Guides 63/25663/4
Shankho Boron Ghosh [Sun, 29 Nov 2020 21:16:36 +0000 (02:46 +0530)]
Added Application Framework Binder in Developer Guides

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>
3 years agoAdded Application Framework in Developer Guides 62/25662/3
Shankho Boron Ghosh [Sun, 29 Nov 2020 19:55:22 +0000 (01:25 +0530)]
Added Application Framework in Developer Guides

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>
3 years agoAdded AGL Layers in Developer Guides 61/25661/3
Shankho Boron Ghosh [Sun, 29 Nov 2020 19:05:56 +0000 (00:35 +0530)]
Added AGL Layers in Developer Guides

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>
3 years agoRenesas: Update package download url 18/25718/3
Frederic Marec [Thu, 3 Dec 2020 15:14:01 +0000 (16:14 +0100)]
Renesas: Update package download url

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>
3 years agoAdded Application guides 60/25660/5
Shankho Boron Ghosh [Sun, 29 Nov 2020 17:57:07 +0000 (23:27 +0530)]
Added Application guides

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>
3 years agoAdded SDK & Service guides 42/25642/4
Shankho Boron Ghosh [Wed, 25 Nov 2020 17:03:01 +0000 (22:33 +0530)]
Added SDK & Service guides

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>
3 years agoUpdated Quickstart with ARM32 & AARCH64 23/25623/6
Shankho Boron Ghosh [Fri, 20 Nov 2020 13:33:56 +0000 (19:03 +0530)]
Updated Quickstart with ARM32 & AARCH64

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>
3 years agoAdded Architecture Guide Overview & Specification 17/25617/5
Shankho Boron Ghosh [Thu, 19 Nov 2020 12:30:41 +0000 (18:00 +0530)]
Added Architecture Guide Overview & Specification

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>
3 years agoGeneral Guidelines : DCO adherence 93/25593/2
Shankho Boron Ghosh [Wed, 18 Nov 2020 18:33:44 +0000 (00:03 +0530)]
General Guidelines : DCO adherence

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>
3 years agoFIX : Internal Links 88/25588/2
Shankho Boron Ghosh [Wed, 18 Nov 2020 15:47:59 +0000 (21:17 +0530)]
FIX : Internal Links

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>
3 years agoContribution Checklist : Minor Nesting 87/25587/2
Shankho Boron Ghosh [Wed, 18 Nov 2020 15:33:07 +0000 (21:03 +0530)]
Contribution Checklist : Minor Nesting

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>
3 years agoRevision of Architecture Guides 86/25586/3
Shankho Boron Ghosh [Wed, 18 Nov 2020 14:25:02 +0000 (19:55 +0530)]
Revision of Architecture Guides

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>
3 years agoAdded Contribution Checklist 80/25580/3
Shankho Boron Ghosh [Mon, 16 Nov 2020 14:28:11 +0000 (19:58 +0530)]
Added Contribution Checklist

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>
3 years agoUpdated Quickstart qemu launch instructions. 81/25581/5
Shankho Boron Ghosh [Mon, 16 Nov 2020 14:47:26 +0000 (20:17 +0530)]
Updated Quickstart qemu launch instructions.

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>
3 years agoAdded APIs introduction 58/25558/4
Shankho Boron Ghosh [Fri, 13 Nov 2020 15:20:03 +0000 (20:50 +0530)]
Added APIs introduction

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>
3 years agoAdded [in-progress] Developer Guides 98/25498/2
Shankho Boron Ghosh [Fri, 30 Oct 2020 04:53:28 +0000 (10:23 +0530)]
Added [in-progress] Developer Guides

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>
3 years agoRenesas: Fix renesas documentation 71/25471/9
Frederic Marec [Thu, 22 Oct 2020 15:55:43 +0000 (17:55 +0200)]
Renesas: Fix renesas documentation

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>
3 years agoAdded Contribution Guide 73/25473/8
Shankho Boron Ghosh [Thu, 22 Oct 2020 18:40:00 +0000 (00:10 +0530)]
Added Contribution Guide

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>
3 years agoDo a fixed config for RTD
Jan-Simon Möller [Wed, 21 Oct 2020 10:48:15 +0000 (12:48 +0200)]
Do a fixed config for RTD

Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: Icd3fdbe08f63730c35325da74d5dae79b6ba37c9

3 years agorewrote quickstart, build-process 07/25407/7
growupboron [Thu, 8 Oct 2020 18:49:18 +0000 (00:19 +0530)]
rewrote quickstart, build-process

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>
3 years agoSimplified doc-site generation 36/25236/2 9.99.4 jellyfish/9.99.4 jellyfish_9.99.4
growupboron [Fri, 11 Sep 2020 11:48:57 +0000 (17:18 +0530)]
Simplified doc-site generation

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>
3 years agoAdd gitreview file 35/25235/2
Jan-Simon Moeller [Fri, 11 Sep 2020 11:15:35 +0000 (13:15 +0200)]
Add gitreview file

Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Change-Id: I8b261fc838ab6ca1fe45e36ede0377c4f3da76c6
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25235

3 years agoInitial empty repository
Jan-Simon Moeller [Thu, 27 Aug 2020 11:51:35 +0000 (11:51 +0000)]
Initial empty repository