From 120a2677992ea299eea5fb5cb0ed1081f76bb92c Mon Sep 17 00:00:00 2001 From: Vinod Ahuja Date: Sat, 19 Nov 2022 13:59:20 -0600 Subject: [PATCH] Updating File name and links in the documentation Updating documentation: 1. Renamed all the files and folder following 01-99 index numbering 2. Matched title name and file name 3. Inserted title in the files where ever missing 4. Updated all the reference links in the documentation Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja Change-Id: Ib73e1f91107646e11b5b19ab6ead4080add506e4 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28170 Reviewed-by: Jan-Simon Moeller Tested-by: Jan-Simon Moeller --- .../01_Quickstart/01_Using_Ready_Made_Images.md} | 0 .../RaspberryPi2-ModelB-debug-serial-cable.png | Bin .../01_Quickstart}/images/vbox-1.png | Bin .../01_Quickstart}/images/vbox-2.png | Bin .../01_Quickstart}/images/vbox-3.png | Bin .../01_Quickstart}/images/vbox-4.png | Bin .../01_Quickstart}/images/vbox-5.png | Bin .../01_Build_Process_Overview.md} | 0 .../02_Preparing_Your_Build_Host.md} | 2 +- .../03_Downloading_AGL_Software.md} | 0 .../04_Initializing_Your_Build_Environment.md} | 0 .../05_Customizing_Your_Build.md} | 3 +- .../06_Building_the_AGL_Image.md} | 8 ++--- ...7_Building_for_x86_(Emulation_and_Hardware).md} | 6 ++-- .../08_Building_for_Raspberry_Pi_4.md} | 6 ++-- .../09_Building_for_Supported_Renesas_Boards.md} | 8 ++--- .../10_Building_for_Virtio.md} | 4 +-- .../RaspberryPi2-ModelB-debug-serial-cable.png | Bin .../images/image-developer-workflow.png | Bin .../02_Building_AGL_Image}/images/vbox-1.png | Bin .../02_Building_AGL_Image}/images/vbox-2.png | Bin .../02_Building_AGL_Image}/images/vbox-3.png | Bin .../02_Building_AGL_Image}/images/vbox-4.png | Bin .../02_Building_AGL_Image}/images/vbox-5.png | Bin ...t_Cluster_(IC-IVI_with_Container_isolation).md} | 21 +++++++------ .../02_Flutter_Instrument_Cluster_(qemu-x86).md} | 24 ++++++++------- .../03_IVI_Flutter_apps.md} | 7 +++-- .../images/flutter_instrument_cluster.png | Bin .../images/flutter_instrument_cluster_map.png | Bin .../images/ivi_homescreen.PNG | Bin .../01_Supported_Hardware_Overview.md} | 16 +++++----- .../02_Supported_Hardware_Images.md} | 8 ++--- .../01_Introduction/01_Overview.md} | 2 +- .../02_AGL_Requirements_Specifications.md} | 0 .../AGL Requirements Specifications.pdf | Bin .../01_Introduction}/images/architecture.jpg | Bin .../02_Security_Blueprint/01_Overview.md} | 0 .../02_Security_Blueprint/02_Hardware.md} | 0 .../02_Security_Blueprint/03_Secure_Boot.md} | 0 .../02_Security_Blueprint/04_Hypervisor.md} | 0 .../02_Security_Blueprint/05_Kernel.md} | 0 .../02_Security_Blueprint/06_Platform.md} | 0 .../02_Security_Blueprint/07_Application.md} | 0 .../02_Security_Blueprint/08_Connectivity.md} | 0 .../09_Update_(Over_The_Air).md} | 4 +-- .../10_Secure_development.md} | 0 .../02_Security_Blueprint/11_Annexes.md} | 0 .../02_Security_Blueprint}/images/App-flow.png | Bin .../images/App_signing_flow.png | Bin .../images/WhiteBoxArchi.png | Bin .../01_Application_Framework/01_Introduction.md} | 6 ++-- .../02_Application_Startup.md} | 2 +- .../01_Setting_Up_AGL_SDK.md} | 0 .../02_AGL_Layers/01_Overview.md} | 0 .../02_AGL_Layers/02_meta_agl.md} | 0 .../02_AGL_Layers/03_meta_agl_demo.md} | 0 .../02_AGL_Layers/04_meta_agl_devel.md} | 6 ++-- .../02_Creating_a_New_Service.md} | 2 +- .../03_Creating_a_New_Application.md} | 2 +- .../04_Creating_a_custom_recipe.md} | 0 .../05_Generic_devices_setup.md} | 0 .../images/AGL_add_recipe.png | Bin docs/05_APIs_and_Services/01_Introduction.md | 5 ++++ .../01_AGL_components.md | 27 +++++++++++++++++ .../02_agl_compositor.md} | 2 +- .../03_waltham_receiver_transmitter.md} | 4 +-- .../04_Rule_Based_Arbitrator.md} | 4 +-- .../05_drm_lease_manager.md} | 0 .../06_application_framework.md} | 0 .../07_pipewire_wireplumber.md} | 0 .../08_Instrument_Cluster_Sound_Management.md} | 4 +++ .../images/agl-compositor/arch_diagram.png | Bin .../images/agl-compositor/drawing_shell.png | Bin .../images/ic-sound-manager/architecture.png | Bin .../ic-sound-manager/pipewire-ic-ipc-calls.png | Bin .../ic-sound-manager/pipewire-ic-ipc-processes.png | Bin .../images/rba/Basic_syntax.png | Bin .../images/rba/model.png | Bin .../01_Getting_Linux_Foundation_account.md} | 0 .../02_Using_Jira_for_current_work_items.md} | 0 .../03_Working_with_Gerrit.md} | 0 .../04_Submitting_Changes.md} | 2 +- .../05_Reviewing_Changes.md} | 0 .../06_Gerrit_Recommended_Practices.md} | 0 .../07_General_Guidelines.md} | 4 +-- .../08_Adding_Documentation.md} | 4 +-- .../09_Contribution_Checklist.md} | 0 .../10_Setup_AGL_LAVA_Lab.md} | 33 +++++++++++---------- .../images/jira-1.png | Bin .../images/jira-2.png | Bin .../images/jira-3.png | Bin .../images/review.png | Bin docs/5_APIs_and_Services/FIXME.md | 0 docs/6_Component_Documentation/1_AGL_components.md | 27 ----------------- docs/index.md | 6 ++-- 95 files changed, 139 insertions(+), 120 deletions(-) rename docs/{1_Getting_Started/1_Quickstart/1_Using_Ready_Made_Images.md => 01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md} (100%) rename docs/{1_Getting_Started/1_Quickstart => 01_Getting_Started/01_Quickstart}/images/RaspberryPi2-ModelB-debug-serial-cable.png (100%) rename docs/{1_Getting_Started/1_Quickstart => 01_Getting_Started/01_Quickstart}/images/vbox-1.png (100%) rename docs/{1_Getting_Started/1_Quickstart => 01_Getting_Started/01_Quickstart}/images/vbox-2.png (100%) rename docs/{1_Getting_Started/1_Quickstart => 01_Getting_Started/01_Quickstart}/images/vbox-3.png (100%) rename docs/{1_Getting_Started/1_Quickstart => 01_Getting_Started/01_Quickstart}/images/vbox-4.png (100%) rename docs/{1_Getting_Started/1_Quickstart => 01_Getting_Started/01_Quickstart}/images/vbox-5.png (100%) rename docs/{1_Getting_Started/2_Building_AGL_Image/1_Build_Process.md => 01_Getting_Started/02_Building_AGL_Image/01_Build_Process_Overview.md} (100%) rename docs/{1_Getting_Started/2_Building_AGL_Image/2_Preparing_Your_Build_Host.md => 01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host.md} (98%) rename docs/{1_Getting_Started/2_Building_AGL_Image/3_Downloading_AGL_Software.md => 01_Getting_Started/02_Building_AGL_Image/03_Downloading_AGL_Software.md} (100%) rename docs/{1_Getting_Started/2_Building_AGL_Image/4_Initializing_Your_Build_Environment.md => 01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md} (100%) rename docs/{1_Getting_Started/2_Building_AGL_Image/5_Customizing_Your_Build.md => 01_Getting_Started/02_Building_AGL_Image/05_Customizing_Your_Build.md} (98%) rename docs/{1_Getting_Started/2_Building_AGL_Image/6_Building_the_AGL_Image.md => 01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image.md} (77%) rename docs/{1_Getting_Started/2_Building_AGL_Image/7_x86_Emulation_and_Hardware.md => 01_Getting_Started/02_Building_AGL_Image/07_Building_for_x86_(Emulation_and_Hardware).md} (98%) rename docs/{1_Getting_Started/2_Building_AGL_Image/8_Raspberry_Pi_4.md => 01_Getting_Started/02_Building_AGL_Image/08_Building_for_Raspberry_Pi_4.md} (97%) rename docs/{1_Getting_Started/2_Building_AGL_Image/9_RCar_Gen_3.md => 01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md} (98%) rename docs/{1_Getting_Started/2_Building_AGL_Image/A_Virtio.md => 01_Getting_Started/02_Building_AGL_Image/10_Building_for_Virtio.md} (96%) rename docs/{1_Getting_Started/2_Building_AGL_Image => 01_Getting_Started/02_Building_AGL_Image}/images/RaspberryPi2-ModelB-debug-serial-cable.png (100%) rename docs/{1_Getting_Started/2_Building_AGL_Image => 01_Getting_Started/02_Building_AGL_Image}/images/image-developer-workflow.png (100%) rename docs/{1_Getting_Started/2_Building_AGL_Image => 01_Getting_Started/02_Building_AGL_Image}/images/vbox-1.png (100%) rename docs/{1_Getting_Started/2_Building_AGL_Image => 01_Getting_Started/02_Building_AGL_Image}/images/vbox-2.png (100%) rename docs/{1_Getting_Started/2_Building_AGL_Image => 01_Getting_Started/02_Building_AGL_Image}/images/vbox-3.png (100%) rename docs/{1_Getting_Started/2_Building_AGL_Image => 01_Getting_Started/02_Building_AGL_Image}/images/vbox-4.png (100%) rename docs/{1_Getting_Started/2_Building_AGL_Image => 01_Getting_Started/02_Building_AGL_Image}/images/vbox-5.png (100%) rename docs/{1_Getting_Started/3_Build_and_Boot_guide_Profile/1_Instrument_Cluster_(IC-IVI_with_Container_isolation).md => 01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md} (85%) rename docs/{1_Getting_Started/3_Build_and_Boot_guide_Profile/2_Flutter_Instrument_Cluster_(qemu-x86).md => 01_Getting_Started/03_Build_and_Boot_guide_Profile/02_Flutter_Instrument_Cluster_(qemu-x86).md} (91%) rename docs/{1_Getting_Started/3_Build_and_Boot_guide_Profile/3_IVI_Flutter_apps.md => 01_Getting_Started/03_Build_and_Boot_guide_Profile/03_IVI_Flutter_apps.md} (94%) rename docs/{1_Getting_Started/3_Build_and_Boot_guide_Profile => 01_Getting_Started/03_Build_and_Boot_guide_Profile}/images/flutter_instrument_cluster.png (100%) rename docs/{1_Getting_Started/3_Build_and_Boot_guide_Profile => 01_Getting_Started/03_Build_and_Boot_guide_Profile}/images/flutter_instrument_cluster_map.png (100%) rename docs/{1_Getting_Started/3_Build_and_Boot_guide_Profile => 01_Getting_Started/03_Build_and_Boot_guide_Profile}/images/ivi_homescreen.PNG (100%) rename docs/{2_Hardware_Support/1_Overview.md => 02_Hardware_Support/01_Supported_Hardware_Overview.md} (72%) rename docs/{2_Hardware_Support/2_Supported_Hardware_Images.md => 02_Hardware_Support/02_Supported_Hardware_Images.md} (83%) rename docs/{3_Architecture_Guides/1_Introduction/1_Overview.md => 03_Architecture_Guides/01_Introduction/01_Overview.md} (94%) rename docs/{3_Architecture_Guides/1_Introduction/2_AGL_Requirements_Specifications.md => 03_Architecture_Guides/01_Introduction/02_AGL_Requirements_Specifications.md} (100%) rename docs/{3_Architecture_Guides/1_Introduction => 03_Architecture_Guides/01_Introduction}/AGL Requirements Specifications.pdf (100%) rename docs/{3_Architecture_Guides/1_Introduction => 03_Architecture_Guides/01_Introduction}/images/architecture.jpg (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint/1_Overview.md => 03_Architecture_Guides/02_Security_Blueprint/01_Overview.md} (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint/2_Hardware.md => 03_Architecture_Guides/02_Security_Blueprint/02_Hardware.md} (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint/3_Secure_Boot.md => 03_Architecture_Guides/02_Security_Blueprint/03_Secure_Boot.md} (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint/4_Hypervisor.md => 03_Architecture_Guides/02_Security_Blueprint/04_Hypervisor.md} (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint/5_Kernel.md => 03_Architecture_Guides/02_Security_Blueprint/05_Kernel.md} (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint/6_Platform.md => 03_Architecture_Guides/02_Security_Blueprint/06_Platform.md} (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint/7_Application.md => 03_Architecture_Guides/02_Security_Blueprint/07_Application.md} (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint/8_Connectivity.md => 03_Architecture_Guides/02_Security_Blueprint/08_Connectivity.md} (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint/9_Update_OTA.md => 03_Architecture_Guides/02_Security_Blueprint/09_Update_(Over_The_Air).md} (98%) rename docs/{3_Architecture_Guides/2_Security_Blueprint/A_Secure_development.md => 03_Architecture_Guides/02_Security_Blueprint/10_Secure_development.md} (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint/B_Annexes.md => 03_Architecture_Guides/02_Security_Blueprint/11_Annexes.md} (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint => 03_Architecture_Guides/02_Security_Blueprint}/images/App-flow.png (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint => 03_Architecture_Guides/02_Security_Blueprint}/images/App_signing_flow.png (100%) rename docs/{3_Architecture_Guides/2_Security_Blueprint => 03_Architecture_Guides/02_Security_Blueprint}/images/WhiteBoxArchi.png (100%) rename docs/{4_Developer_Guides/1_Application_Framework/1_Introduction.md => 04_Developer_Guides/01_Application_Framework/01_Introduction.md} (97%) rename docs/{4_Developer_Guides/1_Application_Framework/2_Application_Startup.md => 04_Developer_Guides/01_Application_Framework/02_Application_Startup.md} (98%) rename docs/{4_Developer_Guides/1_Setting_Up_AGL_SDK.md => 04_Developer_Guides/01_Setting_Up_AGL_SDK.md} (100%) rename docs/{4_Developer_Guides/2_AGL_Layers/1_Overview.md => 04_Developer_Guides/02_AGL_Layers/01_Overview.md} (100%) rename docs/{4_Developer_Guides/2_AGL_Layers/2_meta-agl.md => 04_Developer_Guides/02_AGL_Layers/02_meta_agl.md} (100%) rename docs/{4_Developer_Guides/2_AGL_Layers/3_meta-agl-demo.md => 04_Developer_Guides/02_AGL_Layers/03_meta_agl_demo.md} (100%) rename docs/{4_Developer_Guides/2_AGL_Layers/4_meta-agl-devel.md => 04_Developer_Guides/02_AGL_Layers/04_meta_agl_devel.md} (94%) rename docs/{4_Developer_Guides/2_Creating_a_New_Service.md => 04_Developer_Guides/02_Creating_a_New_Service.md} (97%) rename docs/{4_Developer_Guides/3_Creating_a_New_Application.md => 04_Developer_Guides/03_Creating_a_New_Application.md} (98%) rename docs/{4_Developer_Guides/4_Creating_a_custom_recipe.md => 04_Developer_Guides/04_Creating_a_custom_recipe.md} (100%) rename docs/{4_Developer_Guides/5_General_setup.md => 04_Developer_Guides/05_Generic_devices_setup.md} (100%) rename docs/{4_Developer_Guides => 04_Developer_Guides}/images/AGL_add_recipe.png (100%) create mode 100644 docs/05_APIs_and_Services/01_Introduction.md create mode 100644 docs/06_Component_Documentation/01_AGL_components.md rename docs/{6_Component_Documentation/2_agl-compositor.md => 06_Component_Documentation/02_agl_compositor.md} (99%) rename docs/{6_Component_Documentation/3_waltham-receiver_waltham-transmitter.md => 06_Component_Documentation/03_waltham_receiver_transmitter.md} (98%) rename docs/{6_Component_Documentation/4_rba.md => 06_Component_Documentation/04_Rule_Based_Arbitrator.md} (99%) rename docs/{6_Component_Documentation/5_drm-leasemanager.md => 06_Component_Documentation/05_drm_lease_manager.md} (100%) rename docs/{6_Component_Documentation/6_application_framework.md => 06_Component_Documentation/06_application_framework.md} (100%) rename docs/{6_Component_Documentation/7_pipewire_wireplumber.md => 06_Component_Documentation/07_pipewire_wireplumber.md} (100%) rename docs/{6_Component_Documentation/8_ic-sound-manager.md => 06_Component_Documentation/08_Instrument_Cluster_Sound_Management.md} (99%) rename docs/{6_Component_Documentation => 06_Component_Documentation}/images/agl-compositor/arch_diagram.png (100%) rename docs/{6_Component_Documentation => 06_Component_Documentation}/images/agl-compositor/drawing_shell.png (100%) rename docs/{6_Component_Documentation => 06_Component_Documentation}/images/ic-sound-manager/architecture.png (100%) rename docs/{6_Component_Documentation => 06_Component_Documentation}/images/ic-sound-manager/pipewire-ic-ipc-calls.png (100%) rename docs/{6_Component_Documentation => 06_Component_Documentation}/images/ic-sound-manager/pipewire-ic-ipc-processes.png (100%) rename docs/{6_Component_Documentation => 06_Component_Documentation}/images/rba/Basic_syntax.png (100%) rename docs/{6_Component_Documentation => 06_Component_Documentation}/images/rba/model.png (100%) rename docs/{7_How_To_Contribute/1_Getting_Linux_Foundation_account.md => 07_How_To_Contribute/01_Getting_Linux_Foundation_account.md} (100%) rename docs/{7_How_To_Contribute/2_Using_Jira_for_current_work_items.md => 07_How_To_Contribute/02_Using_Jira_for_current_work_items.md} (100%) rename docs/{7_How_To_Contribute/3_Working_with_Gerrit.md => 07_How_To_Contribute/03_Working_with_Gerrit.md} (100%) rename docs/{7_How_To_Contribute/4_Submitting_Changes.md => 07_How_To_Contribute/04_Submitting_Changes.md} (98%) rename docs/{7_How_To_Contribute/5_Reviewing_Changes.md => 07_How_To_Contribute/05_Reviewing_Changes.md} (100%) rename docs/{7_How_To_Contribute/6_Gerrit_Recommended_Practices.md => 07_How_To_Contribute/06_Gerrit_Recommended_Practices.md} (100%) rename docs/{7_How_To_Contribute/7_General_Guidelines.md => 07_How_To_Contribute/07_General_Guidelines.md} (98%) rename docs/{7_How_To_Contribute/8_Adding_Documentation.md => 07_How_To_Contribute/08_Adding_Documentation.md} (95%) rename docs/{7_How_To_Contribute/9_Contribution_Checklist.md => 07_How_To_Contribute/09_Contribution_Checklist.md} (100%) rename docs/{7_How_To_Contribute/A_How_to_setup_your_own_AGL_LAVA_Lab.md => 07_How_To_Contribute/10_Setup_AGL_LAVA_Lab.md} (98%) rename docs/{7_How_To_Contribute => 07_How_To_Contribute}/images/jira-1.png (100%) rename docs/{7_How_To_Contribute => 07_How_To_Contribute}/images/jira-2.png (100%) rename docs/{7_How_To_Contribute => 07_How_To_Contribute}/images/jira-3.png (100%) rename docs/{7_How_To_Contribute => 07_How_To_Contribute}/images/review.png (100%) delete mode 100644 docs/5_APIs_and_Services/FIXME.md delete mode 100644 docs/6_Component_Documentation/1_AGL_components.md diff --git a/docs/1_Getting_Started/1_Quickstart/1_Using_Ready_Made_Images.md b/docs/01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md similarity index 100% rename from docs/1_Getting_Started/1_Quickstart/1_Using_Ready_Made_Images.md rename to docs/01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md diff --git a/docs/1_Getting_Started/1_Quickstart/images/RaspberryPi2-ModelB-debug-serial-cable.png b/docs/01_Getting_Started/01_Quickstart/images/RaspberryPi2-ModelB-debug-serial-cable.png similarity index 100% rename from docs/1_Getting_Started/1_Quickstart/images/RaspberryPi2-ModelB-debug-serial-cable.png rename to docs/01_Getting_Started/01_Quickstart/images/RaspberryPi2-ModelB-debug-serial-cable.png diff --git a/docs/1_Getting_Started/1_Quickstart/images/vbox-1.png b/docs/01_Getting_Started/01_Quickstart/images/vbox-1.png similarity index 100% rename from docs/1_Getting_Started/1_Quickstart/images/vbox-1.png rename to docs/01_Getting_Started/01_Quickstart/images/vbox-1.png diff --git a/docs/1_Getting_Started/1_Quickstart/images/vbox-2.png b/docs/01_Getting_Started/01_Quickstart/images/vbox-2.png similarity index 100% rename from docs/1_Getting_Started/1_Quickstart/images/vbox-2.png rename to docs/01_Getting_Started/01_Quickstart/images/vbox-2.png diff --git a/docs/1_Getting_Started/1_Quickstart/images/vbox-3.png b/docs/01_Getting_Started/01_Quickstart/images/vbox-3.png similarity index 100% rename from docs/1_Getting_Started/1_Quickstart/images/vbox-3.png rename to docs/01_Getting_Started/01_Quickstart/images/vbox-3.png diff --git a/docs/1_Getting_Started/1_Quickstart/images/vbox-4.png b/docs/01_Getting_Started/01_Quickstart/images/vbox-4.png similarity index 100% rename from docs/1_Getting_Started/1_Quickstart/images/vbox-4.png rename to docs/01_Getting_Started/01_Quickstart/images/vbox-4.png diff --git a/docs/1_Getting_Started/1_Quickstart/images/vbox-5.png b/docs/01_Getting_Started/01_Quickstart/images/vbox-5.png similarity index 100% rename from docs/1_Getting_Started/1_Quickstart/images/vbox-5.png rename to docs/01_Getting_Started/01_Quickstart/images/vbox-5.png diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/1_Build_Process.md b/docs/01_Getting_Started/02_Building_AGL_Image/01_Build_Process_Overview.md similarity index 100% rename from docs/1_Getting_Started/2_Building_AGL_Image/1_Build_Process.md rename to docs/01_Getting_Started/02_Building_AGL_Image/01_Build_Process_Overview.md diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/2_Preparing_Your_Build_Host.md b/docs/01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host.md similarity index 98% rename from docs/1_Getting_Started/2_Building_AGL_Image/2_Preparing_Your_Build_Host.md rename to docs/01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host.md index fdca659..846271f 100644 --- a/docs/1_Getting_Started/2_Building_AGL_Image/2_Preparing_Your_Build_Host.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host.md @@ -20,7 +20,7 @@ development image. The [supported images](https://download.automotivelinux.org/AGL/snapshots/master/latest/) exist for several boards as well as for the Quick EMUlator (QEMU). See the -"[Quickstart](../1_Quickstart/Using_Ready_Made_Images.md)" +"[Quickstart](../01_Quickstart/01_Using_Ready_Made_Images.md)" section for more information on the ready-made images. 1. **Use a Supported Linux Distribution:** To use the AGL software, it is diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/3_Downloading_AGL_Software.md b/docs/01_Getting_Started/02_Building_AGL_Image/03_Downloading_AGL_Software.md similarity index 100% rename from docs/1_Getting_Started/2_Building_AGL_Image/3_Downloading_AGL_Software.md rename to docs/01_Getting_Started/02_Building_AGL_Image/03_Downloading_AGL_Software.md diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/4_Initializing_Your_Build_Environment.md b/docs/01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md similarity index 100% rename from docs/1_Getting_Started/2_Building_AGL_Image/4_Initializing_Your_Build_Environment.md rename to docs/01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/5_Customizing_Your_Build.md b/docs/01_Getting_Started/02_Building_AGL_Image/05_Customizing_Your_Build.md similarity index 98% rename from docs/1_Getting_Started/2_Building_AGL_Image/5_Customizing_Your_Build.md rename to docs/01_Getting_Started/02_Building_AGL_Image/05_Customizing_Your_Build.md index 1c30ddd..31d2852 100644 --- a/docs/1_Getting_Started/2_Building_AGL_Image/5_Customizing_Your_Build.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/05_Customizing_Your_Build.md @@ -21,7 +21,7 @@ To view and customize the `local.conf` file, use any text editor: $ vim $AGL_TOP///conf/local.conf ``` -As mentioned in the "[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)" section, +As mentioned in the "[Initializing Your Build Environment](./04_Initializing_Your_Build_Environment.md)" section, the `local.conf` file gets augmented with AGL configuration fragments based on how you execute the `aglsetup.sh` script. You can see those fragments at the end the configuration file. @@ -148,4 +148,3 @@ In General; $ cd $AGL_TOP/// $ ln -sf $AGL_TOP/site.conf conf/ ``` - diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/6_Building_the_AGL_Image.md b/docs/01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image.md similarity index 77% rename from docs/1_Getting_Started/2_Building_AGL_Image/6_Building_the_AGL_Image.md rename to docs/01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image.md index 1573b56..faa033c 100644 --- a/docs/1_Getting_Started/2_Building_AGL_Image/6_Building_the_AGL_Image.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image.md @@ -15,7 +15,7 @@ This section, provides links to topics with instructions needed to create images three types of supported platforms and for emulation/virtualization using Quick EMUlator (QEMU) or VirtualBox: -* [x86 (Emulation and Hardware)](./5_1_x86_Emulation_and_Hardware.md) -* [Raspberry Pi 4](./5_2_Raspberry_Pi_4.md) -* [R Car Gen 3](./5_3_RCar_Gen_3.md) -* [virtio](./5_4_Virtio.md) +* [x86 (Emulation and Hardware)](./07_Building_for_x86_(Emulation_and_Hardware).md) +* [Raspberry Pi 4](./08_Building_for_Raspberry_Pi_4.md) +* [R Car Gen 3](./09_Building_for_Supported_Renesas_Boards.md) +* [Virtio](./10_Building_for_Virtio.md) diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/7_x86_Emulation_and_Hardware.md b/docs/01_Getting_Started/02_Building_AGL_Image/07_Building_for_x86_(Emulation_and_Hardware).md similarity index 98% rename from docs/1_Getting_Started/2_Building_AGL_Image/7_x86_Emulation_and_Hardware.md rename to docs/01_Getting_Started/02_Building_AGL_Image/07_Building_for_x86_(Emulation_and_Hardware).md index 871179f..e78ef58 100644 --- a/docs/1_Getting_Started/2_Building_AGL_Image/7_x86_Emulation_and_Hardware.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/07_Building_for_x86_(Emulation_and_Hardware).md @@ -12,7 +12,7 @@ VirtualBox, and later the same image can be used to boot any hardware. ## 1. Making Sure Your Build Environment is Correct The -"[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)" +"[Initializing Your Build Environment](./04_Initializing_Your_Build_Environment.md)" section presented generic information for setting up your build environment using the `aglsetup.sh` script. If you are building the AGL demo image for emulation, you need to specify some @@ -53,7 +53,7 @@ $ ln -sf $AGL_TOP/site.conf conf/ ### TBD ``` -**Virt-EG demo image :** +**Virt-EG demo image :** ```sh ### TBD ``` @@ -252,4 +252,4 @@ Once VirtualBox is installed, follow these steps to boot the image: $ sync ``` - 2. Boot from USB drive on the x86 system. \ No newline at end of file + 2. Boot from USB drive on the x86 system. diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/8_Raspberry_Pi_4.md b/docs/01_Getting_Started/02_Building_AGL_Image/08_Building_for_Raspberry_Pi_4.md similarity index 97% rename from docs/1_Getting_Started/2_Building_AGL_Image/8_Raspberry_Pi_4.md rename to docs/01_Getting_Started/02_Building_AGL_Image/08_Building_for_Raspberry_Pi_4.md index e08a51e..2ac3a2a 100644 --- a/docs/1_Getting_Started/2_Building_AGL_Image/8_Raspberry_Pi_4.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/08_Building_for_Raspberry_Pi_4.md @@ -16,7 +16,7 @@ AGL demo image for the Raspberry Pi 4 board. ## 1. Making Sure Your Build Environment is Correct The -"[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)" +"[Initializing Your Build Environment](./04_Initializing_Your_Build_Environment.md)" section presented generic information for setting up your build environment using the `aglsetup.sh` script. If you are building the AGL demo image for a Raspberry Pi 4 board, you need to specify some @@ -49,7 +49,7 @@ the AGL demo image suited for Raspberry Pi 4. Before launching the build, it is good to be sure your build configuration is set up correctly (`/build/conf/local.conf` file). -The "[Customizing Your Build](./4_Customizing_Your_Build.md)" +The "[Customizing Your Build](./05_Customizing_Your_Build.md)" section highlights some common configurations that are useful when building any AGL image. @@ -201,4 +201,4 @@ the image on the Raspberry Pi 4 board: 3. In **local.conf** set `SOTA_PACKED_CREDENTIALS` and `OSTREE_BRANCHNAME`. - More details are available [here](https://docs.ota.here.com/getstarted/dev/raspberry-pi.html). \ No newline at end of file + More details are available [here](https://docs.ota.here.com/getstarted/dev/raspberry-pi.html). diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/9_RCar_Gen_3.md b/docs/01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md similarity index 98% rename from docs/1_Getting_Started/2_Building_AGL_Image/9_RCar_Gen_3.md rename to docs/01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md index 33fc50a..8622194 100644 --- a/docs/1_Getting_Started/2_Building_AGL_Image/9_RCar_Gen_3.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md @@ -145,7 +145,7 @@ Internet. ### 1.4. Making Sure Your Build Environment is Correct The -"[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)" +"[Initializing Your Build Environment](./04_Initializing_Your_Build_Environment.md)" section presented generic information for setting up your build environment using the `aglsetup.sh` script. If you are building an image for a supported Renesas board, @@ -233,7 +233,7 @@ Finally, the AGL features are provided to support building the AGL Demo image for the Renesas board. You can learn more about the AGL Features in the -"[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)" +"[Initializing Your Build Environment](./04_Initializing_Your_Build_Environment.md)" section. ## 2. Using BitBake @@ -589,7 +589,7 @@ In general, the defaults along with the configuration fragments the `aglsetup.sh` script applies in the `local.conf` file are good enough. However, you can customize aspects by editing the `local.conf` file. See the -"[Customizing Your Build](4_Customizing_Your_Build.md)" +"[Customizing Your Build](05_Customizing_Your_Build.md)" section for common configurations you might want to consider. **NOTE:** For detailed explanations of the configurations you can make @@ -623,7 +623,7 @@ MACHINE = "h3-salvator-x" ``` If you ran the `aglsetup.sh` script as described in the -"[Making Sure Your Build Environment is Correct](./5_3_RCar_Gen_3.md#4-making-sure-your-build-environment-is-correct)" +"[Making Sure Your Build Environment is Correct](#14-making-sure-your-build-environment-is-correct)" section earlier, the "agl-devel", "agl-demo", "agl-netboot", "agl-appfw-smack", and "agl-localdev" AGL features will be in effect. These features provide the following: diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/A_Virtio.md b/docs/01_Getting_Started/02_Building_AGL_Image/10_Building_for_Virtio.md similarity index 96% rename from docs/1_Getting_Started/2_Building_AGL_Image/A_Virtio.md rename to docs/01_Getting_Started/02_Building_AGL_Image/10_Building_for_Virtio.md index 3a55fb2..a80479d 100644 --- a/docs/1_Getting_Started/2_Building_AGL_Image/A_Virtio.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/10_Building_for_Virtio.md @@ -2,7 +2,7 @@ title: Building for virtio --- -Virtio is a standartized interface for implementing virtual I/O devices: +Virtio is a standardized interface for implementing virtual I/O devices: * Russell, Rusty. "virtio: towards a de-facto standard for virtual I/O devices." ACM SIGOPS Operating Systems Review 42.5 (2008): 95-103. @@ -17,7 +17,7 @@ similiarly one can run HTML5 based demos, cluster demo, or other AGL images. ## 1. Making Sure Your Build Environment is Correct The -"[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)" +"[Initializing Your Build Environment](./04_Initializing_Your_Build_Environment.md)" section presented generic information for setting up your build environment using the `aglsetup.sh` script. If you are building the AGL demo image for virtio platform, you need to specify diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/images/RaspberryPi2-ModelB-debug-serial-cable.png b/docs/01_Getting_Started/02_Building_AGL_Image/images/RaspberryPi2-ModelB-debug-serial-cable.png similarity index 100% rename from docs/1_Getting_Started/2_Building_AGL_Image/images/RaspberryPi2-ModelB-debug-serial-cable.png rename to docs/01_Getting_Started/02_Building_AGL_Image/images/RaspberryPi2-ModelB-debug-serial-cable.png diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/images/image-developer-workflow.png b/docs/01_Getting_Started/02_Building_AGL_Image/images/image-developer-workflow.png similarity index 100% rename from docs/1_Getting_Started/2_Building_AGL_Image/images/image-developer-workflow.png rename to docs/01_Getting_Started/02_Building_AGL_Image/images/image-developer-workflow.png diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/images/vbox-1.png b/docs/01_Getting_Started/02_Building_AGL_Image/images/vbox-1.png similarity index 100% rename from docs/1_Getting_Started/2_Building_AGL_Image/images/vbox-1.png rename to docs/01_Getting_Started/02_Building_AGL_Image/images/vbox-1.png diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/images/vbox-2.png b/docs/01_Getting_Started/02_Building_AGL_Image/images/vbox-2.png similarity index 100% rename from docs/1_Getting_Started/2_Building_AGL_Image/images/vbox-2.png rename to docs/01_Getting_Started/02_Building_AGL_Image/images/vbox-2.png diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/images/vbox-3.png b/docs/01_Getting_Started/02_Building_AGL_Image/images/vbox-3.png similarity index 100% rename from docs/1_Getting_Started/2_Building_AGL_Image/images/vbox-3.png rename to docs/01_Getting_Started/02_Building_AGL_Image/images/vbox-3.png diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/images/vbox-4.png b/docs/01_Getting_Started/02_Building_AGL_Image/images/vbox-4.png similarity index 100% rename from docs/1_Getting_Started/2_Building_AGL_Image/images/vbox-4.png rename to docs/01_Getting_Started/02_Building_AGL_Image/images/vbox-4.png diff --git a/docs/1_Getting_Started/2_Building_AGL_Image/images/vbox-5.png b/docs/01_Getting_Started/02_Building_AGL_Image/images/vbox-5.png similarity index 100% rename from docs/1_Getting_Started/2_Building_AGL_Image/images/vbox-5.png rename to docs/01_Getting_Started/02_Building_AGL_Image/images/vbox-5.png diff --git a/docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/1_Instrument_Cluster_(IC-IVI_with_Container_isolation).md b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md similarity index 85% rename from docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/1_Instrument_Cluster_(IC-IVI_with_Container_isolation).md rename to docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md index d493f87..9abaad8 100644 --- a/docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/1_Instrument_Cluster_(IC-IVI_with_Container_isolation).md +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md @@ -1,3 +1,7 @@ +--- +title: Instrument Cluster (IC-IVI with Container isolation) +--- + # Build and Boot AGL Instrument Cluster demo image (IC-IVI with Container isolation) ## Required Equipments **1) Tested board:** **[Starter Kit Pro/M3](https://elinux.org/R-Car/Boards/M3SK) + [kingfisher support](https://elinux.org/R-Car/Boards/Kingfisher)** @@ -60,7 +64,7 @@ cp R-Car_Gen3_Series_Evaluation_Software_Package_* $XDG_DOWNLOAD_DIR/ chmod a+rw $XDG_DOWNLOAD_DIR/*.zip ``` ## 5. Define Your Board -- Supporting Starter Kit Pro/M3 + kingfisher Board (For other supported boards, check [Define Your Board](https://docs.automotivelinux.org/en/master/#0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3/)) +- Supporting Starter Kit Pro/M3 + kingfisher Board (For other supported boards, check [Define Your Board](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md)) ```bash export MACHINE=m3ulcb-kf ``` @@ -79,7 +83,7 @@ bitbake lxc-host-image-demo ## 8.Boot the Board (Deploying the AGL Demo Image) - To boot your image on the Renesas board, you need to do three things: -a) Update all [firmware](https://docs.automotivelinux.org/en/marlin/#0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3/#4-troubleshooting) on R-Car M3 Starter Kit board (Flashing firmware). +a) Update all [firmware](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards/#4-troubleshooting) on R-Car M3 Starter Kit board (Flashing firmware). b) Prepare the MicroSD card and Flash image to the MicroSD card using [Etcher](https://www.balena.io/etcher/) (**image file name:** lxc-host-image-demo-m3ulcb-kf.wic.xz), then insert MicroSD card in the R-Car M3SK. @@ -101,8 +105,8 @@ Hit any key to stop autoboot: 0 - Booting image command (for details check [How to boot](https://elinux.org/R-Car/AGL#Instrument_Cluster_with_Container_isolation_demo_image)) ```bash ext4load 0x48080000 Image -ext4load 0x48000000 /boot/r8a77961-ulcb-kf.dtb -booti 0x48080000 - 0x48000000 +ext4load 0x48000000 /boot/r8a77961-ulcb-kf.dtb +booti 0x48080000 - 0x48000000 ``` # Run SoC board Screen @@ -113,12 +117,11 @@ B) Connect HDMI panel to Kingfisher(CN49)for **Cluster Container** ![IC](https://elinux.org/images/7/76/Marlin-lxc-Cluster.JPG) -# Reference webpages +# Reference webpages 1. [eLinux](https://elinux.org/R-Car/AGL) 1. [Kingfisher Board](https://elinux.org/R-Car/Boards/Kingfisher) 1. [R-Car M3SK](https://elinux.org/R-Car/Boards/M3SK#Flashing_firmware) - 1. [agl reference machines](https://docs.automotivelinux.org/en/master/#1_hardware_support/overview/) + 1. [agl reference machines](https://docs.automotivelinux.org/en/master/#02_hardware_support/01_Supported_Hardware_Overview/) 1. [AGL Tech Day Presenation](https://static.sched.com/hosted_files/agltechday2022/3b/agl-techday-202204.pdf) - 1. [Build AGL Image](https://docs.automotivelinux.org/en/master/#0_Getting_Started/2_Building_AGL_Image/0_Build_Process/) - 1. [Building for Supported Renesas Boards](https://docs.automotivelinux.org/en/master/#0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3/) - + 1. [Build AGL Image](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/0_Build_Process_Overview/) + 1. [Building for Supported Renesas Boards](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards/) diff --git a/docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/2_Flutter_Instrument_Cluster_(qemu-x86).md b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/02_Flutter_Instrument_Cluster_(qemu-x86).md similarity index 91% rename from docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/2_Flutter_Instrument_Cluster_(qemu-x86).md rename to docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/02_Flutter_Instrument_Cluster_(qemu-x86).md index 47bb4c0..1ab8ec6 100644 --- a/docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/2_Flutter_Instrument_Cluster_(qemu-x86).md +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/02_Flutter_Instrument_Cluster_(qemu-x86).md @@ -1,8 +1,12 @@ -# Build and Boot AGL Flutter Instrument Cluster demo image made for GSoC +--- +title: Flutter Instrument Cluster (qemu-x86) +--- + +# Build and Boot AGL Flutter Instrument Cluster demo image made for GSoC ## 0. Prepare Your Build Host -- Install the required tools to build an AGL Image. For detailed explanation, check [Preparing Your Build host](https://docs.automotivelinux.org/en/needlefish/#0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host/) +- Install the required tools to build an AGL Image. For detailed explanation, check [Preparing Your Build host](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host/) ## 1. Define Your Top-Level Directory @@ -34,7 +38,7 @@ $ repo sync ## 4. Initialize the build environment using aglsetup.sh Script To initialize the build environment, we must use the setup script. -This script is available here: +This script is available here: ```bash $ $AGL_TOP/master/meta-agl/scripts/aglsetup.sh ``` @@ -51,10 +55,10 @@ $ source master/meta-agl/scripts/aglsetup.sh -b build-flutter-cluster -m qemux86 - Default target paltform: `qemux86-64` ** NOTE: Set the API key in local.conf ** - + - By default navigation will not work, you need to set your openrouteservie API key to the variable `OPENROUTE_API_KEY` in your local.conf - It is present at `$AGL_TOP/master/build-flutter-cluster/conf/local.conf` - + - Example: Just add `OPENROUTE_API_KEY = "your_openrouteservice_api_key"` to the end of local.conf @@ -79,7 +83,7 @@ $ runqemu kvm serialstdio slirp publicvnc To get graphics of the app, you need VNC client like VNC Viewer or Vinagre - Open the VNC client -- Enter the server address as `localhost:0` +- Enter the server address as `localhost:0` That's it, you should get something like this: ![Screenshot](images/flutter_instrument_cluster.png) @@ -90,11 +94,11 @@ To get the navigation, you need to use `kuksa_viss_client` or `kuksa_vss_init.py #### **Using inbuilt `kuksa_vss_init.py` script** After running the build, you should get this: - + ```bash Automotive Grade Linux 13.93.0 qemux86-64 ttyS0 -qemux86-64 login: +qemux86-64 login: ``` @@ -109,7 +113,7 @@ Now run the script root@qemux86-64:~# /usr/sbin/kuksa_vss_init.py ``` -#### **Using `kuksa_viss_client`** +#### **Using `kuksa_viss_client`** Know more about kuksa_viss_client, [Follow this](https://github.com/eclipse/kuksa.val/tree/master/kuksa_viss_client) @@ -122,5 +126,3 @@ Then Test Client> setValue Vehicle.Cabin.SteeringWheel.Switches.Info true ``` ![Screenshot](images/flutter_instrument_cluster_map.png) - - diff --git a/docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/3_IVI_Flutter_apps.md b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_IVI_Flutter_apps.md similarity index 94% rename from docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/3_IVI_Flutter_apps.md rename to docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_IVI_Flutter_apps.md index 6475365..ddce79d 100644 --- a/docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/3_IVI_Flutter_apps.md +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_IVI_Flutter_apps.md @@ -1,8 +1,12 @@ +--- +title: IVI Flutter apps +--- + # Build and Boot AGL Flutter IVI dashboard demo applications made for GSoC ## 0. Prepare Your Build Host -- Install the required tools to build an AGL Image. For detailed explanation, check [Preparing Your Build host](https://docs.automotivelinux.org/en/needlefish/#0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host/) +- Install the required tools to build an AGL Image. For detailed explanation, check [Preparing Your Build host](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host/) ## 1. Define Your Top-Level Directory @@ -75,4 +79,3 @@ To get graphics of the app, you need VNC client like VNC Viewer or Vinagre That's it, you should get something like this: ![Screenshot](images/ivi_homescreen.PNG) - diff --git a/docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster.png b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster.png similarity index 100% rename from docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster.png rename to docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster.png diff --git a/docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster_map.png b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster_map.png similarity index 100% rename from docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster_map.png rename to docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster_map.png diff --git a/docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/images/ivi_homescreen.PNG b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/ivi_homescreen.PNG similarity index 100% rename from docs/1_Getting_Started/3_Build_and_Boot_guide_Profile/images/ivi_homescreen.PNG rename to docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/ivi_homescreen.PNG diff --git a/docs/2_Hardware_Support/1_Overview.md b/docs/02_Hardware_Support/01_Supported_Hardware_Overview.md similarity index 72% rename from docs/2_Hardware_Support/1_Overview.md rename to docs/02_Hardware_Support/01_Supported_Hardware_Overview.md index 56dbd13..eb7c9a4 100644 --- a/docs/2_Hardware_Support/1_Overview.md +++ b/docs/02_Hardware_Support/01_Supported_Hardware_Overview.md @@ -1,5 +1,5 @@ --- -title: Supported Hardware +title: Supported Hardware Overview --- ### Supported Hardware @@ -16,11 +16,11 @@ The following table briefs about the various hardware platforms, supported by AG | BOARD | MACHINE | ARCHITECTURE | QUICK START GUIDE| LATEST SNAPSHOT | |:---------------:|:--------------:|:------------:|:----------------:|:--------------------:| -| QEMU | qemu-x86-64 | x86 |[QEMU Quick Start](https://docs.automotivelinux.org/en/master/#0_Getting_Started/1_Quickstart/Using_Ready_Made_Images/#_top)| [qemu-x86-64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/)| +| QEMU | qemu-x86-64 | x86 |[QEMU Quick Start](https://docs.automotivelinux.org/en/master/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#_top)| [qemu-x86-64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/)| | | qemu-arm | arm32 | | [qemu-arm](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/)| | | qemu-arm64 | arm64 | | [qemu-arm64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/)| | | | | -| RCar Gen 3 | h3ulcb | arm64 |[RCar Gen 3 Quick Start](https://docs.automotivelinux.org/en/master/#0_Getting_Started/1_Quickstart/Using_Ready_Made_Images/#3-r-car-h3sk-h3ulcb-board)| [h3ulcb-nogfx](https://download.automotivelinux.org/AGL/snapshots/master/latest/h3ulcb-nogfx/)| +| RCar Gen 3 | h3ulcb | arm64 |[RCar Gen 3 Quick Start](https://docs.automotivelinux.org/en/master/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#3-r-car-h3sk-h3ulcb-board)| [h3ulcb-nogfx](https://download.automotivelinux.org/AGL/snapshots/master/latest/h3ulcb-nogfx/)| | | h3-salvator-x | arm64 | | | h3-kf | arm64 | | | m3ulcb | arm64 | @@ -28,21 +28,21 @@ The following table briefs about the various hardware platforms, supported by AG | | m3-kf | arm64 | | | agl-refhw | arm64 | | | | | -| Raspberry Pi | raspberrypi4 | arm64 |[Raspberry Pi Quick Start](https://docs.automotivelinux.org/en/master/#0_Getting_Started/1_Quickstart/Using_Ready_Made_Images/#2-raspberry-pi-4)|[raspberrypi4](https://download.automotivelinux.org/AGL/snapshots/master/latest/raspberrypi4/)| +| Raspberry Pi | raspberrypi4 | arm64 |[Raspberry Pi Quick Start](https://docs.automotivelinux.org/en/master/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#2-raspberry-pi-4)|[raspberrypi4](https://download.automotivelinux.org/AGL/snapshots/master/latest/raspberrypi4/)| **Note:** Latest stable release source tar and binary for all the boards can be found [here](https://wiki.automotivelinux.org/agl-distro/release-notes#latest_stable_release) ### Community Supported Boards -| BOARD | MACHINE | ARCHITECTURE | -|:-------------:|:---------------------:|:-------------:| -| BeagleBone | bbe | arm32 | +| BOARD | MACHINE | ARCHITECTURE | +|:-------------:|:---------------------:|:-------------:| +| BeagleBone | bbe | arm32 | | | beaglebone | arm32 | | | | | | i.MX 6 | cubox-i | arm32 | | | imx6qdlsabreauto | arm32 | | | | | -| i.MX 8 | imx8mqevk | arm64 | +| i.MX 8 | imx8mqevk | arm64 | | | imx8mqevk-viv | arm64 | | | | | | virtio | virtio-aarch64 | arm64 | diff --git a/docs/2_Hardware_Support/2_Supported_Hardware_Images.md b/docs/02_Hardware_Support/02_Supported_Hardware_Images.md similarity index 83% rename from docs/2_Hardware_Support/2_Supported_Hardware_Images.md rename to docs/02_Hardware_Support/02_Supported_Hardware_Images.md index 83f3902..1489c2c 100644 --- a/docs/2_Hardware_Support/2_Supported_Hardware_Images.md +++ b/docs/02_Hardware_Support/02_Supported_Hardware_Images.md @@ -12,9 +12,9 @@ AGL supports a variety of interfaces, each requiring unique setup configuration. **Supported boards** : -AGL Reference Boards [QEMU, RCar Gen 3, Raspberry Pi 4](./Overview.md), & agl-refhw +AGL Reference Boards [QEMU, RCar Gen 3, Raspberry Pi 4](./01_Supported_Hardware_Overview.md), & agl-refhw -Community supported Boards [BBE, i. MX 6, i. MX 8](./Overview.md) +Community supported Boards [BBE, i. MX 6, i. MX 8](./01_Supported_Hardware_Overview.md) * Qt Based : @@ -55,7 +55,7 @@ Community supported Boards [BBE, i. MX 6, i. MX 8](./Overview.md) **Supported boards** : -AGL Reference Boards [QEMU, RCar Gen 3, & Raspberry Pi 4](./Overview.md) +AGL Reference Boards [QEMU, RCar Gen 3, & Raspberry Pi 4](./01_Supported_Hardware_Overview.md) * Setting up flags at `aglsetup` script : @@ -78,7 +78,7 @@ Headless demo platform for low-spec boards. **Supported boards** : -Community supported Boards [BeagleBone](./Overview.md) +Community supported Boards [BeagleBone](./01_Supported_Hardware_Overview.md) * Setting up flags at `aglsetup` script : diff --git a/docs/3_Architecture_Guides/1_Introduction/1_Overview.md b/docs/03_Architecture_Guides/01_Introduction/01_Overview.md similarity index 94% rename from docs/3_Architecture_Guides/1_Introduction/1_Overview.md rename to docs/03_Architecture_Guides/01_Introduction/01_Overview.md index 0648aa9..f908ad4 100644 --- a/docs/3_Architecture_Guides/1_Introduction/1_Overview.md +++ b/docs/03_Architecture_Guides/01_Introduction/01_Overview.md @@ -50,4 +50,4 @@ The Application Framework layer provides the APIs for creating both managing and applications on an AGL system. The Services layer contains user space services that all applications can access. The Operating System (OS) layer provides the Linux kernel and device drivers along with standard OS utilities. For IVI (In Vehicle Infotainment) -system a full fledged demo is [available](../../0_Getting_Started/1_Quickstart/Using_Ready_Made_Images.md). \ No newline at end of file +system a full fledged demo is [available](https://docs.automotivelinux.org/en/master/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/). diff --git a/docs/3_Architecture_Guides/1_Introduction/2_AGL_Requirements_Specifications.md b/docs/03_Architecture_Guides/01_Introduction/02_AGL_Requirements_Specifications.md similarity index 100% rename from docs/3_Architecture_Guides/1_Introduction/2_AGL_Requirements_Specifications.md rename to docs/03_Architecture_Guides/01_Introduction/02_AGL_Requirements_Specifications.md diff --git a/docs/3_Architecture_Guides/1_Introduction/AGL Requirements Specifications.pdf b/docs/03_Architecture_Guides/01_Introduction/AGL Requirements Specifications.pdf similarity index 100% rename from docs/3_Architecture_Guides/1_Introduction/AGL Requirements Specifications.pdf rename to docs/03_Architecture_Guides/01_Introduction/AGL Requirements Specifications.pdf diff --git a/docs/3_Architecture_Guides/1_Introduction/images/architecture.jpg b/docs/03_Architecture_Guides/01_Introduction/images/architecture.jpg similarity index 100% rename from docs/3_Architecture_Guides/1_Introduction/images/architecture.jpg rename to docs/03_Architecture_Guides/01_Introduction/images/architecture.jpg diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/1_Overview.md b/docs/03_Architecture_Guides/02_Security_Blueprint/01_Overview.md similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/1_Overview.md rename to docs/03_Architecture_Guides/02_Security_Blueprint/01_Overview.md diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/2_Hardware.md b/docs/03_Architecture_Guides/02_Security_Blueprint/02_Hardware.md similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/2_Hardware.md rename to docs/03_Architecture_Guides/02_Security_Blueprint/02_Hardware.md diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/3_Secure_Boot.md b/docs/03_Architecture_Guides/02_Security_Blueprint/03_Secure_Boot.md similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/3_Secure_Boot.md rename to docs/03_Architecture_Guides/02_Security_Blueprint/03_Secure_Boot.md diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/4_Hypervisor.md b/docs/03_Architecture_Guides/02_Security_Blueprint/04_Hypervisor.md similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/4_Hypervisor.md rename to docs/03_Architecture_Guides/02_Security_Blueprint/04_Hypervisor.md diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/5_Kernel.md b/docs/03_Architecture_Guides/02_Security_Blueprint/05_Kernel.md similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/5_Kernel.md rename to docs/03_Architecture_Guides/02_Security_Blueprint/05_Kernel.md diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/6_Platform.md b/docs/03_Architecture_Guides/02_Security_Blueprint/06_Platform.md similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/6_Platform.md rename to docs/03_Architecture_Guides/02_Security_Blueprint/06_Platform.md diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/7_Application.md b/docs/03_Architecture_Guides/02_Security_Blueprint/07_Application.md similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/7_Application.md rename to docs/03_Architecture_Guides/02_Security_Blueprint/07_Application.md diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/8_Connectivity.md b/docs/03_Architecture_Guides/02_Security_Blueprint/08_Connectivity.md similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/8_Connectivity.md rename to docs/03_Architecture_Guides/02_Security_Blueprint/08_Connectivity.md diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/9_Update_OTA.md b/docs/03_Architecture_Guides/02_Security_Blueprint/09_Update_(Over_The_Air).md similarity index 98% rename from docs/3_Architecture_Guides/2_Security_Blueprint/9_Update_OTA.md rename to docs/03_Architecture_Guides/02_Security_Blueprint/09_Update_(Over_The_Air).md index 60ae8e4..0476b7a 100644 --- a/docs/3_Architecture_Guides/2_Security_Blueprint/9_Update_OTA.md +++ b/docs/03_Architecture_Guides/02_Security_Blueprint/09_Update_(Over_The_Air).md @@ -11,7 +11,7 @@ confidentiality and the legitimacy of the transmitted data. ## Attack Vectors -Updates Over The Air are one of the most common points where an attacker will +Updates Over The Air (OTA) are one of the most common points where an attacker will penetrate. An OTA update mechanism is one of the highest threats in the system. If an attacker is able to install his own application or firmware on the system, he can get the same level of access that the original application or firmware @@ -151,4 +151,4 @@ to manage in a simple way the packets (i.g. Android like). Domain | Improvement ------------- | ----------------- -Update-SOTA-1 | Part to complete. \ No newline at end of file +Update-SOTA-1 | Part to complete. diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/A_Secure_development.md b/docs/03_Architecture_Guides/02_Security_Blueprint/10_Secure_development.md similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/A_Secure_development.md rename to docs/03_Architecture_Guides/02_Security_Blueprint/10_Secure_development.md diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/B_Annexes.md b/docs/03_Architecture_Guides/02_Security_Blueprint/11_Annexes.md similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/B_Annexes.md rename to docs/03_Architecture_Guides/02_Security_Blueprint/11_Annexes.md diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/images/App-flow.png b/docs/03_Architecture_Guides/02_Security_Blueprint/images/App-flow.png similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/images/App-flow.png rename to docs/03_Architecture_Guides/02_Security_Blueprint/images/App-flow.png diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/images/App_signing_flow.png b/docs/03_Architecture_Guides/02_Security_Blueprint/images/App_signing_flow.png similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/images/App_signing_flow.png rename to docs/03_Architecture_Guides/02_Security_Blueprint/images/App_signing_flow.png diff --git a/docs/3_Architecture_Guides/2_Security_Blueprint/images/WhiteBoxArchi.png b/docs/03_Architecture_Guides/02_Security_Blueprint/images/WhiteBoxArchi.png similarity index 100% rename from docs/3_Architecture_Guides/2_Security_Blueprint/images/WhiteBoxArchi.png rename to docs/03_Architecture_Guides/02_Security_Blueprint/images/WhiteBoxArchi.png diff --git a/docs/4_Developer_Guides/1_Application_Framework/1_Introduction.md b/docs/04_Developer_Guides/01_Application_Framework/01_Introduction.md similarity index 97% rename from docs/4_Developer_Guides/1_Application_Framework/1_Introduction.md rename to docs/04_Developer_Guides/01_Application_Framework/01_Introduction.md index 957858a..24d8c1a 100644 --- a/docs/4_Developer_Guides/1_Application_Framework/1_Introduction.md +++ b/docs/04_Developer_Guides/01_Application_Framework/01_Introduction.md @@ -45,7 +45,7 @@ components, most of those being maintained under the application enumeration and startup AGL also provides reference implementations whenever possible and relevant, located in -the [meta-agl](/3_Developer_Guides/6_AGL_Layers/2_meta-agl/) layer under `meta-app-framework`. At the +the [meta-agl](/04_Developer_Guides/02_AGL_Layers/02_meta_agl/) layer under `meta-app-framework`. At the moment, the Application Framework contains 2 such components: - `agl-session`: `systemd` unit files for user sessions management @@ -70,7 +70,7 @@ developers can take advantage of some of its advanced features, allowing for imp reliability and security. Each service should be represented by a `systemd` unit file installed to the appropriate -location. More details can be obtained from the [Creating a New Service](/3_Developer_Guides/2_Creating_a_New_Service/) +location. More details can be obtained from the [Creating a New Service](/04_Developer_Guides/02_Creating_a_New_Service/) document. # User session management @@ -147,4 +147,4 @@ interface for services and applications to: - request the startup and/or activation of a specific application - be notified when applications are started or terminated -`applaunchd` is described with more details in [the following document](../2_Application_Startup/). +`applaunchd` is described with more details in [the following document](../02_Application_Startup/). diff --git a/docs/4_Developer_Guides/1_Application_Framework/2_Application_Startup.md b/docs/04_Developer_Guides/01_Application_Framework/02_Application_Startup.md similarity index 98% rename from docs/4_Developer_Guides/1_Application_Framework/2_Application_Startup.md rename to docs/04_Developer_Guides/01_Application_Framework/02_Application_Startup.md index 4841ce5..232f41e 100644 --- a/docs/4_Developer_Guides/1_Application_Framework/2_Application_Startup.md +++ b/docs/04_Developer_Guides/01_Application_Framework/02_Application_Startup.md @@ -17,7 +17,7 @@ simple reference implementation for this function. In order to provide a language-independent interface for applications and service to use, AGL includes `applaunchd`, a user service part of the default session. -*Note: as mentioned [previously](1_Introduction/), services are managed using `systemd` +*Note: as mentioned [previously](../01_Introduction/), services are managed using `systemd` and are therefore not in the scope of this document.* # Application launcher service diff --git a/docs/4_Developer_Guides/1_Setting_Up_AGL_SDK.md b/docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md similarity index 100% rename from docs/4_Developer_Guides/1_Setting_Up_AGL_SDK.md rename to docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md diff --git a/docs/4_Developer_Guides/2_AGL_Layers/1_Overview.md b/docs/04_Developer_Guides/02_AGL_Layers/01_Overview.md similarity index 100% rename from docs/4_Developer_Guides/2_AGL_Layers/1_Overview.md rename to docs/04_Developer_Guides/02_AGL_Layers/01_Overview.md diff --git a/docs/4_Developer_Guides/2_AGL_Layers/2_meta-agl.md b/docs/04_Developer_Guides/02_AGL_Layers/02_meta_agl.md similarity index 100% rename from docs/4_Developer_Guides/2_AGL_Layers/2_meta-agl.md rename to docs/04_Developer_Guides/02_AGL_Layers/02_meta_agl.md diff --git a/docs/4_Developer_Guides/2_AGL_Layers/3_meta-agl-demo.md b/docs/04_Developer_Guides/02_AGL_Layers/03_meta_agl_demo.md similarity index 100% rename from docs/4_Developer_Guides/2_AGL_Layers/3_meta-agl-demo.md rename to docs/04_Developer_Guides/02_AGL_Layers/03_meta_agl_demo.md diff --git a/docs/4_Developer_Guides/2_AGL_Layers/4_meta-agl-devel.md b/docs/04_Developer_Guides/02_AGL_Layers/04_meta_agl_devel.md similarity index 94% rename from docs/4_Developer_Guides/2_AGL_Layers/4_meta-agl-devel.md rename to docs/04_Developer_Guides/02_AGL_Layers/04_meta_agl_devel.md index 8932b82..d662ed5 100644 --- a/docs/4_Developer_Guides/2_AGL_Layers/4_meta-agl-devel.md +++ b/docs/04_Developer_Guides/02_AGL_Layers/04_meta_agl_devel.md @@ -116,7 +116,7 @@ environment using the `aglsetup.sh` script. For information on how to use the `aglsetup.sh` script to initialize your build environment, see the -"[Initializing Your Build Environment](../../0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md)" +"[Initializing Your Build Environment](../../01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md)" section. Once you have included the AGL feature, you can build your image. @@ -137,7 +137,7 @@ environment using the `aglsetup.sh` script. For information on how to use the `aglsetup.sh` script to initialize your build environment, see the -"[Initializing Your Build Environment](../../0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md)" +"[Initializing Your Build Environment](../../01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md)" section. -Once you have included the AGL feature, you can build your image. \ No newline at end of file +Once you have included the AGL feature, you can build your image. diff --git a/docs/4_Developer_Guides/2_Creating_a_New_Service.md b/docs/04_Developer_Guides/02_Creating_a_New_Service.md similarity index 97% rename from docs/4_Developer_Guides/2_Creating_a_New_Service.md rename to docs/04_Developer_Guides/02_Creating_a_New_Service.md index 0fb2453..22e98ea 100644 --- a/docs/4_Developer_Guides/2_Creating_a_New_Service.md +++ b/docs/04_Developer_Guides/02_Creating_a_New_Service.md @@ -40,7 +40,7 @@ WantedBy=agl-session.target ``` The `WantedBy=agl-session.target` indicates the service is part of the default AGL -user session, as mentioned in the [Application Framework](../1_Application_Framework/1_Introduction/#user-session-management) +user session, as mentioned in the [Application Framework](../01_Application_Framework/01_Introduction/#user-session-management) documentation. The `Restart=on-failure` directive ensures the service will be automatically diff --git a/docs/4_Developer_Guides/3_Creating_a_New_Application.md b/docs/04_Developer_Guides/03_Creating_a_New_Application.md similarity index 98% rename from docs/4_Developer_Guides/3_Creating_a_New_Application.md rename to docs/04_Developer_Guides/03_Creating_a_New_Application.md index ed89ecc..3fb7682 100644 --- a/docs/4_Developer_Guides/3_Creating_a_New_Application.md +++ b/docs/04_Developer_Guides/03_Creating_a_New_Application.md @@ -8,7 +8,7 @@ Applications are: - Graphical interface allowing user to interact with. Applications are executed by `applaunchd`, the AGL -[application launcher service](../1_Application_Framework/2_Application_Startup/). +[application launcher service](../01_Application_Framework/02_Application_Startup/). # Basic requirements diff --git a/docs/4_Developer_Guides/4_Creating_a_custom_recipe.md b/docs/04_Developer_Guides/04_Creating_a_custom_recipe.md similarity index 100% rename from docs/4_Developer_Guides/4_Creating_a_custom_recipe.md rename to docs/04_Developer_Guides/04_Creating_a_custom_recipe.md diff --git a/docs/4_Developer_Guides/5_General_setup.md b/docs/04_Developer_Guides/05_Generic_devices_setup.md similarity index 100% rename from docs/4_Developer_Guides/5_General_setup.md rename to docs/04_Developer_Guides/05_Generic_devices_setup.md diff --git a/docs/4_Developer_Guides/images/AGL_add_recipe.png b/docs/04_Developer_Guides/images/AGL_add_recipe.png similarity index 100% rename from docs/4_Developer_Guides/images/AGL_add_recipe.png rename to docs/04_Developer_Guides/images/AGL_add_recipe.png diff --git a/docs/05_APIs_and_Services/01_Introduction.md b/docs/05_APIs_and_Services/01_Introduction.md new file mode 100644 index 0000000..95570c6 --- /dev/null +++ b/docs/05_APIs_and_Services/01_Introduction.md @@ -0,0 +1,5 @@ +--- +title: Introduction +--- + +API and Service documentation is under development. Will be updated as and when they are ready. diff --git a/docs/06_Component_Documentation/01_AGL_components.md b/docs/06_Component_Documentation/01_AGL_components.md new file mode 100644 index 0000000..57dbe29 --- /dev/null +++ b/docs/06_Component_Documentation/01_AGL_components.md @@ -0,0 +1,27 @@ +--- +title: AGL Components +--- + +## Components under development within AGL + +### Graphics + +- [The AGL compositor](02_agl_compositor.md) +- [Waltham receiver/transmitter configuration](03_waltham_receiver_transmitter.md) +- [DRM lease manager](05_drm_lease_manager.md) + + +### Sound + +- [Pipewire & Wireplumber](07_pipewire_wireplumber.md) +- [IC and Sound Manager](08_Instrument_Cluster_Sound_Management.md) + + +### Policies + +- [Rule based arbitrator](04_Rule_Based_Arbitrator.md) + + +### Lifecycle management + +- [Application Framework](../../04_Developer_Guides/01_Application_Framework/01_Introduction/) diff --git a/docs/6_Component_Documentation/2_agl-compositor.md b/docs/06_Component_Documentation/02_agl_compositor.md similarity index 99% rename from docs/6_Component_Documentation/2_agl-compositor.md rename to docs/06_Component_Documentation/02_agl_compositor.md index 437e6a7..0d3a135 100644 --- a/docs/6_Component_Documentation/2_agl-compositor.md +++ b/docs/06_Component_Documentation/02_agl_compositor.md @@ -16,7 +16,7 @@ library, to control and signal back to the compositor when applications were started, among other things. Management of applications, starting, running and stopping them is done in AGL -with AppFW [Application Framework Management](../3_Developer_Guides/1_Application_Framework/1_Introduction.md), +with AppFW [Application Framework Management](../04_Developer_Guides/01_Application_Framework/01_Introduction.md), which is an umbrella name to denote the suite of tools and daemons that handle all of that. It is integrated with systemd and with the current security model. Applications can use AppFW to hang off data, and to pass it down to diff --git a/docs/6_Component_Documentation/3_waltham-receiver_waltham-transmitter.md b/docs/06_Component_Documentation/03_waltham_receiver_transmitter.md similarity index 98% rename from docs/6_Component_Documentation/3_waltham-receiver_waltham-transmitter.md rename to docs/06_Component_Documentation/03_waltham_receiver_transmitter.md index b98de32..8397f0e 100644 --- a/docs/6_Component_Documentation/3_waltham-receiver_waltham-transmitter.md +++ b/docs/06_Component_Documentation/03_waltham_receiver_transmitter.md @@ -50,7 +50,7 @@ server side of the Waltham protocol and is capable of displaying the incoming buffers but also process input events locally and forward them with the help of the Waltham protocol back at the transmitter side, which in turn will update the image contents and stream to the receiver, showing the changes caused by -that input. +that input. ECU 1 ECU 2 @@ -92,5 +92,5 @@ use `agl-shell-app-id` ini entry for that particular output. agl-shell-app-id= Alternatively, and programmatically, one can use the -[agl-shell-desktop](1_agl-compositor.md#private-extensions) protocol and inform +[agl-shell-desktop](../02_agl_compositor#private-extensions) protocol and inform the compositor that it should migrate it to other, remote outputs. diff --git a/docs/6_Component_Documentation/4_rba.md b/docs/06_Component_Documentation/04_Rule_Based_Arbitrator.md similarity index 99% rename from docs/6_Component_Documentation/4_rba.md rename to docs/06_Component_Documentation/04_Rule_Based_Arbitrator.md index 9661923..e1a311d 100644 --- a/docs/6_Component_Documentation/4_rba.md +++ b/docs/06_Component_Documentation/04_Rule_Based_Arbitrator.md @@ -1,10 +1,10 @@ --- -title: Rule Based Arbitrator (RBA) +title: Rule Based Arbitrator --- # RBA -Rule Based Arbitrator decides which of the content to display when a large number of contents to be displayed on the cockpit display device (CID, meter, HUD, etc.) occur simultaneously under a certain rule (arbitration). +Rule Based Arbitrator (RBA) decides which of the content to display when a large number of contents to be displayed on the cockpit display device (CID, meter, HUD, etc.) occur simultaneously under a certain rule (arbitration). ### 1. Overview diff --git a/docs/6_Component_Documentation/5_drm-leasemanager.md b/docs/06_Component_Documentation/05_drm_lease_manager.md similarity index 100% rename from docs/6_Component_Documentation/5_drm-leasemanager.md rename to docs/06_Component_Documentation/05_drm_lease_manager.md diff --git a/docs/6_Component_Documentation/6_application_framework.md b/docs/06_Component_Documentation/06_application_framework.md similarity index 100% rename from docs/6_Component_Documentation/6_application_framework.md rename to docs/06_Component_Documentation/06_application_framework.md diff --git a/docs/6_Component_Documentation/7_pipewire_wireplumber.md b/docs/06_Component_Documentation/07_pipewire_wireplumber.md similarity index 100% rename from docs/6_Component_Documentation/7_pipewire_wireplumber.md rename to docs/06_Component_Documentation/07_pipewire_wireplumber.md diff --git a/docs/6_Component_Documentation/8_ic-sound-manager.md b/docs/06_Component_Documentation/08_Instrument_Cluster_Sound_Management.md similarity index 99% rename from docs/6_Component_Documentation/8_ic-sound-manager.md rename to docs/06_Component_Documentation/08_Instrument_Cluster_Sound_Management.md index e1c22f4..57f6dd2 100644 --- a/docs/6_Component_Documentation/8_ic-sound-manager.md +++ b/docs/06_Component_Documentation/08_Instrument_Cluster_Sound_Management.md @@ -1,3 +1,7 @@ +--- +title: Instrument Cluster Sound Management +--- + # Instrument Cluster Sound Management ## Introduction diff --git a/docs/6_Component_Documentation/images/agl-compositor/arch_diagram.png b/docs/06_Component_Documentation/images/agl-compositor/arch_diagram.png similarity index 100% rename from docs/6_Component_Documentation/images/agl-compositor/arch_diagram.png rename to docs/06_Component_Documentation/images/agl-compositor/arch_diagram.png diff --git a/docs/6_Component_Documentation/images/agl-compositor/drawing_shell.png b/docs/06_Component_Documentation/images/agl-compositor/drawing_shell.png similarity index 100% rename from docs/6_Component_Documentation/images/agl-compositor/drawing_shell.png rename to docs/06_Component_Documentation/images/agl-compositor/drawing_shell.png diff --git a/docs/6_Component_Documentation/images/ic-sound-manager/architecture.png b/docs/06_Component_Documentation/images/ic-sound-manager/architecture.png similarity index 100% rename from docs/6_Component_Documentation/images/ic-sound-manager/architecture.png rename to docs/06_Component_Documentation/images/ic-sound-manager/architecture.png diff --git a/docs/6_Component_Documentation/images/ic-sound-manager/pipewire-ic-ipc-calls.png b/docs/06_Component_Documentation/images/ic-sound-manager/pipewire-ic-ipc-calls.png similarity index 100% rename from docs/6_Component_Documentation/images/ic-sound-manager/pipewire-ic-ipc-calls.png rename to docs/06_Component_Documentation/images/ic-sound-manager/pipewire-ic-ipc-calls.png diff --git a/docs/6_Component_Documentation/images/ic-sound-manager/pipewire-ic-ipc-processes.png b/docs/06_Component_Documentation/images/ic-sound-manager/pipewire-ic-ipc-processes.png similarity index 100% rename from docs/6_Component_Documentation/images/ic-sound-manager/pipewire-ic-ipc-processes.png rename to docs/06_Component_Documentation/images/ic-sound-manager/pipewire-ic-ipc-processes.png diff --git a/docs/6_Component_Documentation/images/rba/Basic_syntax.png b/docs/06_Component_Documentation/images/rba/Basic_syntax.png similarity index 100% rename from docs/6_Component_Documentation/images/rba/Basic_syntax.png rename to docs/06_Component_Documentation/images/rba/Basic_syntax.png diff --git a/docs/6_Component_Documentation/images/rba/model.png b/docs/06_Component_Documentation/images/rba/model.png similarity index 100% rename from docs/6_Component_Documentation/images/rba/model.png rename to docs/06_Component_Documentation/images/rba/model.png diff --git a/docs/7_How_To_Contribute/1_Getting_Linux_Foundation_account.md b/docs/07_How_To_Contribute/01_Getting_Linux_Foundation_account.md similarity index 100% rename from docs/7_How_To_Contribute/1_Getting_Linux_Foundation_account.md rename to docs/07_How_To_Contribute/01_Getting_Linux_Foundation_account.md diff --git a/docs/7_How_To_Contribute/2_Using_Jira_for_current_work_items.md b/docs/07_How_To_Contribute/02_Using_Jira_for_current_work_items.md similarity index 100% rename from docs/7_How_To_Contribute/2_Using_Jira_for_current_work_items.md rename to docs/07_How_To_Contribute/02_Using_Jira_for_current_work_items.md diff --git a/docs/7_How_To_Contribute/3_Working_with_Gerrit.md b/docs/07_How_To_Contribute/03_Working_with_Gerrit.md similarity index 100% rename from docs/7_How_To_Contribute/3_Working_with_Gerrit.md rename to docs/07_How_To_Contribute/03_Working_with_Gerrit.md diff --git a/docs/7_How_To_Contribute/4_Submitting_Changes.md b/docs/07_How_To_Contribute/04_Submitting_Changes.md similarity index 98% rename from docs/7_How_To_Contribute/4_Submitting_Changes.md rename to docs/07_How_To_Contribute/04_Submitting_Changes.md index d226450..871f448 100644 --- a/docs/7_How_To_Contribute/4_Submitting_Changes.md +++ b/docs/07_How_To_Contribute/04_Submitting_Changes.md @@ -11,7 +11,7 @@ source developers. This section contains guidelines for submitting code changes for review. For more information on how to submit a change using Gerrit, please see [Working -with Gerrit](./3_Working_with_Gerrit.md). +with Gerrit](./03_Working_with_Gerrit.md). Changes are submitted as Git commits. Each commit must contain: diff --git a/docs/7_How_To_Contribute/5_Reviewing_Changes.md b/docs/07_How_To_Contribute/05_Reviewing_Changes.md similarity index 100% rename from docs/7_How_To_Contribute/5_Reviewing_Changes.md rename to docs/07_How_To_Contribute/05_Reviewing_Changes.md diff --git a/docs/7_How_To_Contribute/6_Gerrit_Recommended_Practices.md b/docs/07_How_To_Contribute/06_Gerrit_Recommended_Practices.md similarity index 100% rename from docs/7_How_To_Contribute/6_Gerrit_Recommended_Practices.md rename to docs/07_How_To_Contribute/06_Gerrit_Recommended_Practices.md diff --git a/docs/7_How_To_Contribute/7_General_Guidelines.md b/docs/07_How_To_Contribute/07_General_Guidelines.md similarity index 98% rename from docs/7_How_To_Contribute/7_General_Guidelines.md rename to docs/07_How_To_Contribute/07_General_Guidelines.md index 66092de..3720066 100644 --- a/docs/7_How_To_Contribute/7_General_Guidelines.md +++ b/docs/07_How_To_Contribute/07_General_Guidelines.md @@ -34,7 +34,7 @@ provide a fix, we would welcome that gladly! Please assign the JIRA issue to yourself, then you can submit a change request (CR). **NOTE:** If you need help with submitting your first CR, we have created a -brief [tutorial](./4_Submitting_Changes.md) for you. +brief [tutorial](../04_Submitting_Changes) for you. ## Fixing issues and working stories @@ -132,7 +132,7 @@ merged. description of the change. Each change MUST include the JIRA identifier corresponding to the change (e.g. [SPEC-1234]). This can be in the title but should also be in the body of the commit message. See the [complete - requirements](./4_Submitting_Changes.md) for an acceptable change request. + requirements](../04_Submitting_Changes) for an acceptable change request. **NOTE:** That Gerrit will automatically create a hyperlink to the JIRA item. diff --git a/docs/7_How_To_Contribute/8_Adding_Documentation.md b/docs/07_How_To_Contribute/08_Adding_Documentation.md similarity index 95% rename from docs/7_How_To_Contribute/8_Adding_Documentation.md rename to docs/07_How_To_Contribute/08_Adding_Documentation.md index 3777ecc..a54058d 100644 --- a/docs/7_How_To_Contribute/8_Adding_Documentation.md +++ b/docs/07_How_To_Contribute/08_Adding_Documentation.md @@ -34,7 +34,7 @@ $ git clone "ssh://@gerrit.automotivelinux.org:29418/AGL/documentation" && $ sudo pip install -r requirements.txt ``` -3. Serve locally (defaultly rendered at [127.0.0.1:8000/](127.0.0.1:8000/)): +3. Serve locally (default rendered at [127.0.0.1:8000/](127.0.0.1:8000/)): ```sh $ sudo mkdocs serve @@ -110,7 +110,7 @@ the site. $ sudo pip3 install git-review  ``` -2. Write commit message (**Note:** Please follow [submitting changes](./4_Submitting_Changes.md) guideline to write your commit message.) +2. Write commit message (**Note:** Please follow [submitting changes](./04_Submitting_Changes.md) guideline to write your commit message.) ```sh # track all the new changes diff --git a/docs/7_How_To_Contribute/9_Contribution_Checklist.md b/docs/07_How_To_Contribute/09_Contribution_Checklist.md similarity index 100% rename from docs/7_How_To_Contribute/9_Contribution_Checklist.md rename to docs/07_How_To_Contribute/09_Contribution_Checklist.md diff --git a/docs/7_How_To_Contribute/A_How_to_setup_your_own_AGL_LAVA_Lab.md b/docs/07_How_To_Contribute/10_Setup_AGL_LAVA_Lab.md similarity index 98% rename from docs/7_How_To_Contribute/A_How_to_setup_your_own_AGL_LAVA_Lab.md rename to docs/07_How_To_Contribute/10_Setup_AGL_LAVA_Lab.md index f445b8c..0bf5308 100644 --- a/docs/7_How_To_Contribute/A_How_to_setup_your_own_AGL_LAVA_Lab.md +++ b/docs/07_How_To_Contribute/10_Setup_AGL_LAVA_Lab.md @@ -1,3 +1,6 @@ +--- +title: Setup_AGL_LAVA_Lab +--- ## Prerequisites ## @@ -5,7 +8,7 @@ As well as the packages docker, docker-compose and pyyaml mentioned in the top level README, you will need the following: - + 1) The following ports are forwarded to docker and therefore need to be kept free @@ -29,11 +32,11 @@ like to create your own lab in the email so that the relevant user permissions can be set. - + ## Steps to create your own LAVA lab ## - + 1) Clone AGL lava-docker image: @@ -45,13 +48,13 @@ cd lava-docker ``` - + 2) On the LAVA master web GUI, create a new API token: https://lava.automotivelinux.org/api/tokens/ - + 3) Connect all the DUTs' serial to usb and ethernet connections to the host. @@ -70,7 +73,7 @@ instructions. You will need the following: - power on, off and reset commads for the power switch - + To get the uart idvendor and idproduct, unplug and re-plugin the USB cable of the @@ -82,7 +85,7 @@ sudo dmesg | grep idvendor ``` - + To get the uart devpath, run the command: @@ -92,13 +95,13 @@ udevadm info -a -n /dev/ttyUSB1 |grep devpath | head -n1 ``` - + NOTE: Make sure you have at least one "board" included. (It is easiest to keep qemu). - + 5) Run the automated setup script: @@ -108,7 +111,7 @@ qemu). ``` - + 7) Check the web GUI to see if the lab has successfully connected to the LAVA @@ -130,11 +133,11 @@ docker ps ``` - + LAVA logs can be found in `/var/log/lava-dispatcher/`. - + 8) Helper scripts @@ -150,11 +153,11 @@ There are a few helper scripts to automate starting/stopping the lab. ``` - + ## Adding new device-type templates ## - + Not all device types are supported by default. Templates for new devices will @@ -162,7 +165,7 @@ need to be added to the LAVA master. Please submit new templates to the agl-dev- mailing list. - + Before you submit any new device-type templates, please verify that they work. diff --git a/docs/7_How_To_Contribute/images/jira-1.png b/docs/07_How_To_Contribute/images/jira-1.png similarity index 100% rename from docs/7_How_To_Contribute/images/jira-1.png rename to docs/07_How_To_Contribute/images/jira-1.png diff --git a/docs/7_How_To_Contribute/images/jira-2.png b/docs/07_How_To_Contribute/images/jira-2.png similarity index 100% rename from docs/7_How_To_Contribute/images/jira-2.png rename to docs/07_How_To_Contribute/images/jira-2.png diff --git a/docs/7_How_To_Contribute/images/jira-3.png b/docs/07_How_To_Contribute/images/jira-3.png similarity index 100% rename from docs/7_How_To_Contribute/images/jira-3.png rename to docs/07_How_To_Contribute/images/jira-3.png diff --git a/docs/7_How_To_Contribute/images/review.png b/docs/07_How_To_Contribute/images/review.png similarity index 100% rename from docs/7_How_To_Contribute/images/review.png rename to docs/07_How_To_Contribute/images/review.png diff --git a/docs/5_APIs_and_Services/FIXME.md b/docs/5_APIs_and_Services/FIXME.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/6_Component_Documentation/1_AGL_components.md b/docs/6_Component_Documentation/1_AGL_components.md deleted file mode 100644 index a251b05..0000000 --- a/docs/6_Component_Documentation/1_AGL_components.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: AGL Components ---- - -## Components under development within AGL - -### Graphics - -- [The AGL compositor](1_agl-compositor.md) -- [Waltham receiver/transmitter configuration](2_waltham-receiver_waltham-transmitter.md) -- [DRM lease manager](4_drm-leasemanager.md) - - -### Sound - -- [Pipewire & Wireplumber](6_pipewire_wireplumber.md) -- [IC and Sound Manager](7_ic-sound-manager.md) - - -### Policies - -- [Rule based arbitrator](3_rba.md) - - -### Lifecycle management - -- [Application Framework](../3_Developer_Guides/1_Application_Framework/1_Introduction.md) diff --git a/docs/index.md b/docs/index.md index caddfb4..b7b5039 100644 --- a/docs/index.md +++ b/docs/index.md @@ -47,13 +47,13 @@ The "Getting Started" topics allow you to quickly accomplish some work using AGL. You can use the "Getting Started" sections to do the following: -* [Quickstart](./0_Getting_Started/1_Quickstart/Using_Ready_Made_Images.md) to quickly install the pre-built images into an emulation or hardware platform. +* [Quickstart](./01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md) to quickly install the pre-built images into an emulation or hardware platform. -* [Learn How to Build an AGL Image](./0_Getting_Started/2_Building_AGL_Image/0_Build_Process.md) by working +* [Learn How to Build an AGL Image](./01_Getting_Started/02_Building_AGL_Image/01_Build_Process_Overview.md) by working through fundamental steps that show you how to build for various supported hardware targets (e.g. Raspberry PI boards). -* [Learn How to Create an Application](./3_Developer_Guides/1_Setting_Up_AGL_SDK.md) using the +* [Learn How to Create an Application](./04_Developer_Guides/01_Setting_Up_AGL_SDK.md) using the application development workflow. -- 2.16.6