AGL/documentation.git
20 months agoAdd steps to enable navigation 00/28000/2
aakash-s45 [Fri, 16 Sep 2022 13:09:39 +0000 (18:39 +0530)]
Add steps to enable navigation

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>
20 months agoAdd documentation for Flutter Instrument Cluster 69/27969/4
aakash-s45 [Sat, 3 Sep 2022 08:32:12 +0000 (14:02 +0530)]
Add documentation for Flutter Instrument Cluster

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>
20 months agoFixing broken links 72/27972/3
Vinod Ahuja [Mon, 5 Sep 2022 20:55:39 +0000 (15:55 -0500)]
Fixing broken links

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>
20 months agoFixing Several broken links referring to Yacto 71/27971/4
Vinod Ahuja [Mon, 5 Sep 2022 20:30:11 +0000 (15:30 -0500)]
Fixing Several broken links referring to Yacto

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>
20 months agoFixing broken links in Developer Guides 57/27957/5
Vinod Ahuja [Mon, 29 Aug 2022 21:15:57 +0000 (16:15 -0500)]
Fixing broken links in Developer Guides

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>
20 months agoUpdating Hardware Support Page 41/27941/5
Vinod Ahuja [Mon, 22 Aug 2022 20:55:00 +0000 (15:55 -0500)]
Updating Hardware Support Page

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>
21 months agoAdding description of supported boards 55/27855/2
Vinod Ahuja [Mon, 1 Aug 2022 20:09:33 +0000 (15:09 -0500)]
Adding description of supported boards

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>
21 months agoAdding participate section and other minor edits 93/27793/4
Vinod Ahuja [Mon, 25 Jul 2022 19:00:11 +0000 (14:00 -0500)]
Adding participate section and other minor edits

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>
21 months agoFirst round of updates to Hardware Support page 95/27795/2 13.92.0 13.93.0 needlefish/13.92.0 needlefish/13.93.0 needlefish_13.92.0 needlefish_13.93.0
Jan-Simon Moeller [Tue, 26 Jul 2022 13:36:18 +0000 (15:36 +0200)]
First round of updates to Hardware Support page

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

21 months agoAdding submitting change guideline 63/27763/3
Vinod Ahuja [Tue, 12 Jul 2022 20:10:01 +0000 (15:10 -0500)]
Adding submitting change guideline

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>
21 months agoReducing Image size as discussed in SAT meeting 49/27749/2
Vinod Ahuja [Fri, 8 Jul 2022 18:48:56 +0000 (13:48 -0500)]
Reducing Image size as discussed in SAT meeting

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>
22 months agoDocument building isolation container images 67/27667/7 13.91.0 needlefish/13.91.0 needlefish_13.91.0
Mohamed Amir [Thu, 16 Jun 2022 13:09:24 +0000 (22:09 +0900)]
Document building isolation container images

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>
23 months ago1_agl-compositor.md: Document how to start client shell 67/27567/2
Marius Vlad [Fri, 27 May 2022 12:02:48 +0000 (15:02 +0300)]
1_agl-compositor.md: Document how to start client shell

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>
23 months ago1_agl-compositor.md: We're no longer using SMACK 66/27566/2
Marius Vlad [Fri, 27 May 2022 11:57:34 +0000 (14:57 +0300)]
1_agl-compositor.md: We're no longer using SMACK

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>
23 months ago5_Component_Documentation: Fix Application Framework links 65/27565/2
Marius Vlad [Fri, 27 May 2022 11:32:41 +0000 (14:32 +0300)]
5_Component_Documentation: Fix Application Framework links

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>
23 months agoFixed quote errors in echo expressions 75/27575/2
amanarora9848 [Tue, 31 May 2022 17:42:54 +0000 (23:12 +0530)]
Fixed quote errors in echo expressions

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>
23 months agoFixed internal link error 20/27520/2
amanarora9848 [Mon, 23 May 2022 18:24:49 +0000 (23:54 +0530)]
Fixed internal link error

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>
2 years agoFixed indentation error for a sub-bullet point 70/27370/2
amanarora9848 [Sat, 9 Apr 2022 11:51:23 +0000 (17:21 +0530)]
Fixed indentation error for a sub-bullet point

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>
2 years agoRCAR: Update BSP version in documentation 31/27231/2 12.93.0 marlin/12.93.0 marlin_12.93.0
Frederic Marec [Tue, 1 Mar 2022 09:19:33 +0000 (10:19 +0100)]
RCAR: Update BSP version in documentation

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>
2 years ago3_Developer_Guides: add new app framework documentation 66/27166/4
Arnaud Ferraris [Fri, 11 Feb 2022 20:06:46 +0000 (21:06 +0100)]
3_Developer_Guides: add new app framework documentation

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>
2 years ago3_Developer_Guides/5_General_setup: Simple docs for video camera streaming 34/27134/2
Marius Vlad [Thu, 3 Feb 2022 22:06:30 +0000 (00:06 +0200)]
3_Developer_Guides/5_General_setup: Simple docs for video camera streaming

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>
2 years ago0_AGL_components.md: Clear up missing files 33/27133/2
Marius Vlad [Thu, 3 Feb 2022 14:32:46 +0000 (16:32 +0200)]
0_AGL_components.md: Clear up missing files

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>
2 years agoUpdate to documentation before Marlin 97/27097/3 12.92.0 marlin/12.92.0 marlin_12.92.0
Jan-Simon Möller [Wed, 26 Jan 2022 11:25:31 +0000 (12:25 +0100)]
Update to documentation before Marlin

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

2 years agoFix a spell miss of document. 51/27051/2 12.91.0 marlin/12.91.0 marlin_12.91.0
Qiu Tingting [Tue, 21 Dec 2021 07:23:11 +0000 (15:23 +0800)]
Fix a spell miss of document.

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>
2 years agoModify document of 2_Creating_a_New_Service 52/26952/2
duerpei [Thu, 2 Dec 2021 02:06:31 +0000 (10:06 +0800)]
Modify document of 2_Creating_a_New_Service

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>
2 years agoUpdate Renesas documentation following new BSP 80/26880/2
Frederic Marec [Mon, 22 Nov 2021 11:11:27 +0000 (12:11 +0100)]
Update Renesas documentation following new BSP

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>
2 years agoRenesas: Add bitbake command each target 31/26731/4
Ronan Le Martret [Fri, 8 Oct 2021 09:38:05 +0000 (11:38 +0200)]
Renesas: Add bitbake command each target

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>
2 years agoRenesas: Add Build Environment Insrument Cluster 30/26730/4
Ronan Le Martret [Fri, 8 Oct 2021 09:37:48 +0000 (11:37 +0200)]
Renesas: Add Build Environment Insrument Cluster

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>
2 years agorenesas: refactoring documentation 27/26627/5 12.90.1 marlin/12.90.1 marlin_12.90.1
Frederic Marec [Fri, 10 Sep 2021 13:14:17 +0000 (15:14 +0200)]
renesas: refactoring documentation

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>
2 years ago0_AGL_components: Provide some structure to the AGL developed compoments 69/26669/3
Marius Vlad [Thu, 23 Sep 2021 13:17:59 +0000 (16:17 +0300)]
0_AGL_components: Provide some structure to the AGL developed compoments

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>
2 years agodocs/5_Component_Documentation/1_agl-compositor: Slash headers 68/26668/3
Marius Vlad [Thu, 23 Sep 2021 14:49:03 +0000 (17:49 +0300)]
docs/5_Component_Documentation/1_agl-compositor: Slash headers

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>
2 years agodocs/5_Component_Documentation/1_agl-compositor: Update agl-compositor docs 67/26667/3
Marius Vlad [Thu, 23 Sep 2021 12:52:07 +0000 (15:52 +0300)]
docs/5_Component_Documentation/1_agl-compositor: Update agl-compositor docs

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>
2 years agodocs: add a design document for the "IC sound manager" setup 63/26663/2
George Kiagiadakis [Mon, 20 Sep 2021 16:59:08 +0000 (19:59 +0300)]
docs: add a design document for the "IC sound manager" setup

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>
2 years agoRBA docs: Update step to generate .json from .rba file 72/26672/2
Anusha Gugale [Mon, 27 Sep 2021 09:39:31 +0000 (15:09 +0530)]
RBA docs: Update step to generate .json from .rba file

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>
2 years agoAdded RBA tool documentation 41/26541/4
Anusha Gugale [Mon, 26 Jul 2021 17:54:38 +0000 (23:24 +0530)]
Added RBA tool documentation

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>
2 years agoUpdate file link for h3ulcb on master 03/26503/2
Jan-Simon Möller [Wed, 14 Jul 2021 18:01:27 +0000 (20:01 +0200)]
Update file link for h3ulcb on master

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

2 years agoMore docs in 7_pyagl.md 89/26489/2
Edi Feschiyan [Wed, 7 Jul 2021 11:49:10 +0000 (14:49 +0300)]
More docs in 7_pyagl.md

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>
2 years agoAdd initial DRM Lease Manager documentation 50/26450/2 12.90.0 marlin/12.90.0 marlin_12.90.0
Damian Hobson-Garcia [Thu, 24 Jun 2021 03:53:40 +0000 (12:53 +0900)]
Add initial DRM Lease Manager documentation

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>
2 years agodocs: add basic pipewire/wireplumber documentation 48/26448/2
George Kiagiadakis [Tue, 22 Jun 2021 15:16:10 +0000 (18:16 +0300)]
docs: add basic pipewire/wireplumber documentation

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>
2 years agoupdate test sample command for pyagl test doc 20/26420/2 11.92.0 lamprey/11.92.0 lamprey_11.92.0
liuyahui [Tue, 8 Jun 2021 02:58:34 +0000 (10:58 +0800)]
update test sample command for pyagl test doc

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>
2 years agoAdding preliminary pyagl documentation 91/26391/2
Edi Feschiyan [Fri, 4 Jun 2021 16:37:24 +0000 (19:37 +0300)]
Adding preliminary pyagl documentation

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>
2 years agoUpdate irc and quickstart links 92/26392/2
Jan-Simon Möller [Sun, 6 Jun 2021 20:44:15 +0000 (22:44 +0200)]
Update irc and quickstart links

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>
3 years agoFix branch name from jellyfish to koi in the document of koi release 62/26162/2 11.91.0 lamprey/11.91.0 lamprey_11.91.0
Naoto YAMAGUCHI [Tue, 16 Mar 2021 13:40:27 +0000 (22:40 +0900)]
Fix branch name from jellyfish to koi in the document of koi release

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

3 years ago[Renesas] Update Renesas bsp version 49/26149/3
Frederic Marec [Tue, 9 Mar 2021 14:33:20 +0000 (15:33 +0100)]
[Renesas] Update Renesas bsp version

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>
3 years agodocs/2_waltham-receiver_waltham-transmitter: Added waltham documentation 37/26137/2
Marius Vlad [Fri, 5 Mar 2021 13:46:14 +0000 (15:46 +0200)]
docs/2_waltham-receiver_waltham-transmitter: Added waltham documentation

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>
3 years ago1_agl-compositor: Mention agl-shell-app-id for migrating apps 36/26136/2
Marius Vlad [Thu, 4 Mar 2021 12:35:19 +0000 (14:35 +0200)]
1_agl-compositor: Mention agl-shell-app-id for migrating apps

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>
3 years agoAdd documentation on how to add a LAVA lab 39/26139/2
Jan-Simon Möller [Fri, 5 Mar 2021 17:39:16 +0000 (18:39 +0100)]
Add documentation on how to add a LAVA lab

Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: I3a70e7dcfd4e517256dff3b167139cecb0476f4f
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26139

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