diff options
Diffstat (limited to 'content')
30 files changed, 1307 insertions, 933 deletions
diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml deleted file mode 100644 index f1709a0..0000000 --- a/content/tocs/apis_services/fetched_files.yml +++ /dev/null @@ -1,420 +0,0 @@ -############################################################################################################## -# GLOBAL DOCUMENT -# <any REPOSITORY option>: global setting -# repositories: array of objects with documents to fetchd -# -# REPOSITORY ENTRY: -# - -# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration) -# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration) -# git_name: repository name (%repo%) -# git_commit: git reference: revision, SHA1, branch... (%commit%) -# src_prefix: prefix prepended to %source% -# dst_prefix: prefix prepended to destination name -# documents: array of documents to fetch -# -# DOCUMENT ENTRY: -# source: subpath within repository (%source%) -# destination: local destination filename -# label|title: name within TOC -# edit|editURI: specific edition URI -# -# EXAMPLE: -# ------------------------------------ -# url: "GERRIT_FETCH" -# git_commit: "master" -# repositories: -# - -# git_name: src/foo -# src_prefix: docs -# dst_prefix: foodocs -# documents: -# - source: intro.md -# label: Introduction -# - source: topic/README.md -# destination: topic.md -# label: My Topic -# ------------------------------------ -############################################################################################################## - -url_fetch: GERRIT_FETCH -git_commit: AGL_GERRIT_BRANCH - -repositories: -- - git_name: src/app-framework-main - src_prefix: docs - dst_prefix: af-main - documents: - - source: 0-introduction.md - label: Introduction - - source: 0-kristi-introduction.md - label: API Reference - - source: 1-afm-daemons.md - label: The afm daemons - - source: 2-widgets.md - label: Widgets - - source: 2.1-widgets.md - label: Overview of widgets - - source: 2.2-config.xml.md - label: Widget configuration file - - source: 3-permissions.md - label: Permissions - - source: 4-quick-tutorial.md - label: Quick Tutorial - - source: pictures/afm-daemons.svg - - source: pictures/AppFW-APP_install_sequences.svg - - source: pictures/make-units.svg - - source: pictures/Security_model_history.svg - - source: pictures/triskel_iot_bzh.svg - -- - git_name: src/app-framework-binder - src_prefix: docs - dst_prefix: af-binder - documents: - - source: index.md - label: Binder index - - source: afb-overview.md - label: Overview - - source: afb-binding-writing.md - label: How to write a binding ? - - source: afb-binding-references.md - label: Binding references - - source: reference-v3/types-and-globals.md - label: Types and globals - - source: reference-v3/func-api.md - label: Functions of class afb_api - - source: reference-v3/func-req.md - label: Functions of class afb_req - - source: reference-v3/func-event.md - label: Functions of class afb_event - - source: reference-v3/func-daemon.md - label: Functions of class afb_daemon - - source: reference-v3/func-service.md - label: Functions of class afb_service - - source: reference-v3/macro-log.md - label: Macros for logging - - source: afb-migration-to-binding-v3.md - label: Migration to bindings v3 - - source: afb-events-guide.md - label: Binder events guide - - source: afb-application-writing.md - label: Binder Application writing guide - - source: afb-daemon-vocabulary.md - label: Binder daemon vocabulary - - source: afb-desktop-package.md - label: Installing the binder on a desktop - - source: afb-daemon-debugging.md - label: Debugging binder and bindings - - source: afb-daemon-options.md - label: Options of afb-daemon - - source: protocol-x-afb-ws-json1.md - label: WebSocket protocol x-afb-ws-json1 - - source: annexes.md - label: Annexes - - source: REVISIONS.md - label: Document revision - - source: legacy/afb-migration-v1-to-v2.md - label: LEGACY Migration from v1 to v2 - - source: legacy/afb-binding-v2-references.md - label: LEGACY Binding V2 references - - source: pictures/AFB_for_services.svg - - source: pictures/basis.svg - - source: pictures/interconnection.svg - - source: pictures/signaling-basis.svg - - source: pictures/tic-tac-toe.svg - - source: pictures/triskel_iot_bzh.svg - -- - git_name: apps/agl-service-can-low-level - src_prefix: docs - dst_prefix: signaling - documents: - - source: 1-Architecture.md - destination: low-can-architecture.md - label: Architecture presentation - - source: 2-Installation.md - destination: low-can-installation-guide.md - label: Installation Guide - - source: 3-Usage.md - destination: low-can-usage-guide.md - label: Usage Guide - - source: images/CAN_bindings_communication.png - - source: images/CAN_level_mapping.png - - source: images/OpenXC_to_AGL.png - -- - git_name: apps/app-afb-test - src_prefix: docs - dst_prefix: afb-test - documents: - - source: 0_Installation.md - destination: Installation.md - label: Installation - - source: 1_Write_the_tests.md - destination: write-the-tests.md - label: Write the tests - - source: 2_The_test_widget.md - destination: the-test-widget.md - label: The test widget - - source: 3_Launch_the_tests.md - destination: launch-the-tests.md - label: Launch the tests - - source: 4_Tests_Examples.md - destination: tests-examples.md - label: Tests examples - - source: Reference/0_BindingTestFunctions.md - destination: binding-test-functions.md - label: Binding Test Functions - - source: Reference/1_BindingAssertFunctions.md - destination: binding-assert-functions.md - label: Binding Assert Functions - - source: Reference/2_TestFrameworkFunctions.md - destination: test-framework-functions.md - label: Test Framework Functions - - source: Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md - destination: general-assertions.md - label: General Assertions - - source: Reference/LuaUnitAssertionFunctions/1_ValueAssertions.md - destination: value-assertions.md - label: Value Assertions - - source: Reference/LuaUnitAssertionFunctions/2_ScientificAssertions.md - destination: scientific-assertions.md - label: Scientific Assertions - - source: Reference/LuaUnitAssertionFunctions/3_StringAssertions.md - destination: string-assertions.md - label: String Assertions - - source: Reference/LuaUnitAssertionFunctions/4_ErrorAssertions.md - destination: error-assertions.md - label: Error Assertions - - source: Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md - destination: type-assertions.md - label: Type Assertions - - source: Reference/LuaUnitAssertionFunctions/6_TableAssertions.md - destination: table-assertions.md - label: Table Assertions - -- - url_fetch: GITHUB_FETCH - url_edit: GITHUB_EDIT - git_name: iotbzh/high-level-viwi-service - git_commit: master - src_prefix: docs - dst_prefix: signaling - documents: - - source: 1-Architecture.md - destination: high-viwi-architecture.md - label: Architecture presentation - - source: 2-Install-Usage.md - destination: high-viwi-install-usage-guide.md - label: Installation and Usage Guide - - source: images/high-level-arch.png -- - git_name: apps/agl-service-signal-composer - src_prefix: docs/part-1/ - dst_prefix: signaling - documents: - - source: 1-Architecture.md - destination: signal-composer-architecture.md - label: Architecture presentation - - source: 2-Configuration.md - destination: signal-composer-configuration.md - label: Configuration - - source: 3-Plugins.md - destination: signal-composer-plugins.md - label: Plugins - - source: 4-SignalComposerAPI.md - destination: signal-composer-api.md - label: Signal Composer API - - source: pictures/Global_Signaling_Architecture.png - - source: pictures/iotbzh_logo_small.png -- - url_fetch: GITHUB_FETCH - url_edit: GITHUB_EDIT - git_name: iotbzh/agl-documentation - git_commit: master - documents: - - source: candevstudio/docs/1_Usage.md - - source: candevstudio/docs/2_can_device_socketcan_backend.md - - source: candevstudio/docs/3_Add_CAN_Device.md - - source: candevstudio/docs/4_Configure_CanRawSender_Node.md - - source: candevstudio/docs/5_Using_CanRawView.md - - source: candevstudio/docs/pictures/CANdevStudio.png - - source: candevstudio/docs/pictures/canrawsender.png - - source: candevstudio/docs/pictures/canrawviewer.png - -- - url_fetch: AGL_GITHUB_FETCH - url_edit: AGL_GITHUB_EDIT - git_name: automotive-grade-linux/docs-sources - git_commit: AGL_GITHUB_BRANCH - src_prefix: docs/app-framework - dst_prefix: af-binder - documents: - - source: index.md - destination: resources.md - label: Resources -- - url_fetch: AGL_GITHUB_FETCH - url_edit: AGL_GITHUB_EDIT - git_name: automotive-grade-linux/docs-sources - git_commit: AGL_GITHUB_BRANCH - src_prefix: docs/signaling - dst_prefix: signaling - documents: - - source: architecture.md - destination: architecture.md - label: Signaling Architecture - - source: index.md - destination: resources.md - label: Resources - - source: images/agent-arch.svg - - source: images/agent-sample.svg - - source: images/cloud-arch.svg - - source: images/can-generator.svg - - source: images/distributed-arch.svg - - source: images/distributed-arch.png - - source: images/signal-service-arch.svg -- - url_fetch: https://iot.bzh/download/public/2016/%source% - dst_prefix: iotbzh2016 - documents: - - source: signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf - - source: signaling/AGL-Message-Signaling-Developer-Guidelines.pdf -- - url_fetch: AGL_GITHUB_FETCH - url_edit: AGL_GITHUB_EDIT - git_name: automotive-grade-linux/docs-sources - git_commit: AGL_GITHUB_BRANCH - src_prefix: docs/audio - dst_prefix: audio - documents: - - source: 4a-framework.md - destination: 4a-framework.md - label: 4a-framework - - source: bluez-alsa.md - destination: bluez-alsa.md - label: bluez-alsa -- - git_name: apps/agl-service-audio-4a - src_prefix: docs - dst_prefix: audio - documents: - - source: 4a-framework/README.md - label: Architecture - - source: 4a-framework/concepts.md - label: Concepts - - source: 4a-framework/components.md - label: Components - - source: 4a-framework/images/4a-architecture.svg - - source: 4a-framework/images/apps-architecture.svg - - source: 4a-framework/images/agl-audio-arch.png - - source: high-level-api/README.md - label: Abstract - - source: high-level-api/kickstart.md - label: Kickstart - - source: high-level-api/reference.md - label: Reference - - source: high-level-api/TipsAndTricks/AdjustVolumes.md - label: Adjust volumes - - source: high-level-api/TipsAndTricks/4aTools.md - label: 4a-tools - - source: high-level-api/TipsAndTricks/Devices.md - label: Devices - - source: high-level-api/TipsAndTricks/HALs.md - label: HALs - - source: high-level-api/TipsAndTricks/images/changeSound.png - - source: high-level-api/TipsAndTricks/images/MixerBaseMenu.png -- - git_name: src/pulseaudio-module-4a - dst_prefix: audio - documents: - - source: README.md - destination: pulseaudio-module-4a.md - label: Pulseaudio - 4A Integration Module -- - git_name: apps/agl-service-homescreen - src_prefix: doc/ - dst_prefix: hmi-framework/ - documents: - - source: ApplicationGuide.md - destination: 3_1-HomeScreen-Guide.md - label: Home Screen Developper Guide - - source: parts/software-stack.png - - source: parts/initialize-set-event-handler.svg - - source: parts/tap_shortcut.svg - - source: parts/showWindow.svg - - source: parts/on_screen_message.svg - - source: parts/showOnScreen.svg - - source: parts/showNotification.svg - - source: parts/showInformation.svg -- - git_name: apps/agl-service-windowmanager - src_prefix: doc/ - dst_prefix: hmi-framework/ - documents: - - source: ApplicationGuide.md - destination: 3_2-WindowManager-Guide.md - label: Window Manager Developper Guide - - source: parts/state_change_example.png - - source: parts/wm_software_stack.png - - source: parts/wm_layer_stack.png - - source: parts/wm_area.png - - source: parts/request_role.png - - source: parts/hmi_framework_designed_seq_toyota.png - - source: parts/deactivate_window.png - - source: parts/example_split.png -- - git_name: apps/agl-service-soundmanager - src_prefix: doc/ - dst_prefix: hmi-framework/ - documents: - - source: ApplicationGuide.md - destination: 3_3-SoundManager-Guide.md - label: Sound Manager Developper Guide - - source: Display_Audio_Transition1.md - destination: Display_Audio_Transition1.md - label: Sound Manager Developper Guide 2 - - source: Display_Audio_Transition2.md - destination: Display_Audio_Transition2.md - label: Sound Manager Developper Guide 3 - - source: parts/seq_startup.svg - - source: parts/am-component.png - - source: parts/seq_registration.svg - - source: parts/seq_connectsoundroute.svg - - source: parts/seq_startsoundstreaming.svg - - source: parts/seq_requestsoundmode.svg - - source: parts/seq_setmutestate.svg - - source: parts/seq_changevolume.svg - - source: parts/seq_stopsoundstreaming.svg - - source: parts/seq_disconnectsoundroute.svg - - source: parts/software-stack.png - - source: parts/seq_releasesoundmode.svg - - source: parts/typical-usecase.png - - source: parts/am-component.png -- - git_name: apps/homescreen - src_prefix: homescreen/docs - dst_prefix: homescreen - documents: - - source: homescreen_api.md - label: HomeScreen API - - source: pictures/api_getAllSurfacesOfProcess.png - destination: pictures/api_getAllSurfacesOfProcess.png - - source: pictures/api_getSurfaceStatus_1.png - destination: pictures/api_getSurfaceStatus_1.png - - source: pictures/api_getSurfaceStatus_2.png - destination: pictures/api_getSurfaceStatus_2.png - - source: pictures/api_getSurfaceStatus_3.png - destination: pictures/api_getSurfaceStatus_3.png - - source: pictures/api_hardKeyPressed.png - destination: pictures/api_hardKeyPressed.png - - source: pictures/api_renderSurfaceToArea.png - destination: pictures/api_renderSurfaceToArea.png - - source: pictures/api_renderSurfaceToAreaAllowed.png - destination: pictures/api_renderSurfaceToAreaAllowed.png - - source: pictures/api_requestSurfaceIdToFullScreen.png - destination: pictures/api_requestSurfaceIdToFullScreen.png - - source: pictures/api_surfaceVisibilityChanged.png - destination: pictures/api_surfaceVisibilityChanged.png diff --git a/content/tocs/apis_services/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml index f9a9015..993d60f 100644 --- a/content/tocs/apis_services/section_flounder.yml +++ b/content/tocs/apis_services/section_flounder.yml @@ -23,7 +23,6 @@ books: id: flounder-docs-source-signaling url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/signaling-book.yml dst_prefix: signaling @@ -42,7 +41,6 @@ books: order: 80 url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/app-framework-book.yml dst_prefix: af-binder @@ -73,7 +71,6 @@ books: id: flounder-audio-developer-guides url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/audio-book.yml dst_prefix: audio @@ -90,7 +87,6 @@ books: id: flounder-hmi-framework url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/hmi-framework-book.yml dst_prefix: hmi-framework diff --git a/content/tocs/apis_services/section_guppy.yml b/content/tocs/apis_services/section_guppy.yml index cce1fa1..b75bbac 100644 --- a/content/tocs/apis_services/section_guppy.yml +++ b/content/tocs/apis_services/section_guppy.yml @@ -22,7 +22,6 @@ books: id: docs-source-signaling url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/signaling-book.yml dst_prefix: signaling @@ -44,7 +43,6 @@ books: order: 80 url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/app-framework-book.yml dst_prefix: af-binder @@ -72,7 +70,6 @@ books: id: audio-developer-guides url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/audio-book.yml dst_prefix: audio @@ -89,7 +86,6 @@ books: id: hmi-framework url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/hmi-framework-book.yml dst_prefix: hmi-framework diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index 273dfe8..e3d087d 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -22,7 +22,6 @@ books: id: docs-source-signaling url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/signaling-book.yml dst_prefix: signaling @@ -41,7 +40,6 @@ books: order: 80 url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/app-framework-book.yml dst_prefix: af-binder @@ -70,7 +68,6 @@ books: id: audio-developer-guides url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/audio-book.yml dst_prefix: audio @@ -87,7 +84,6 @@ books: id: hmi-framework url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/hmi-framework-book.yml dst_prefix: hmi-framework diff --git a/content/tocs/architecture/fetched_files.yml b/content/tocs/architecture/fetched_files.yml deleted file mode 100644 index b57d5d2..0000000 --- a/content/tocs/architecture/fetched_files.yml +++ /dev/null @@ -1,140 +0,0 @@ -############################################################################################################## -# GLOBAL DOCUMENT -# <any REPOSITORY option>: global setting -# repositories: array of objects with documents to fetchd -# -# REPOSITORY ENTRY: -# - -# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration) -# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration) -# git_name: repository name (%repo%) -# git_commit: git reference: revision, SHA1, branch... (%commit%) -# src_prefix: prefix prepended to %source% -# dst_prefix: prefix prepended to destination name -# documents: array of documents to fetch -# -# DOCUMENT ENTRY: -# source: subpath within repository (%source%) -# destination: local destination filename -# label|title: name within TOC -# edit|editURI: specific edition URI -# -# EXAMPLE: -# ------------------------------------ -# url: "GERRIT_FETCH" -# git_commit: "master" -# repositories: -# - -# git_name: src/foo -# src_prefix: docs -# dst_prefix: foodocs -# documents: -# - source: intro.md -# label: Introduction -# - source: topic/README.md -# destination: topic.md -# label: My Topic -# ------------------------------------ -############################################################################################################## - -#git_commit: # default defined in _tocs/xxxx/latest.yml -#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source) - -url_fetch: GERRIT_FETCH -git_commit: AGL_GERRIT_BRANCH - -repositories: -- - url_fetch: https://wiki.automotivelinux.org/_media/%source% - dst_prefix: AGL_Specifications - documents: - - source: agl_spec_v1.0_final.pdf - -- - url_fetch: AGL_GITHUB_FETCH - url_edit: AGL_GITHUB_EDIT - git_name: automotive-grade-linux/docs-sources - git_commit: AGL_GITHUB_BRANCH - src_prefix: docs/security-blueprint - dst_prefix: security - documents: - - source: README.md - label: Introduction - - source: WhiteBoxArchi.png - label: AGL architecture - - source: annexes/0_Abstract.md - label: Annexes - - source: annexes/ConfigNotes.md - label: Config notes - - source: annexes/todoNotes.md - label: Todo notes - - source: part-1/0_Abstract.md - label: Introduction - - source: part-2/0_Abstract.md - label: Introduction - - source: part-2/1-Image.md - label: Image - - source: part-2/2-Communication-modes.md - label: Communication modes - - source: part-2/3-Consoles.md - label: Consoles - - source: part-3/0_Abstract.md - label: Introduction - - source: part-4/0_Abstract.md - label: Introduction - - source: part-4/1-General.md - label: General - - source: part-4/2-Memory.md - label: Memory - - source: part-4/3-Consoles.md - label: Consoles - - source: part-4/4-Debug.md - label: Debug - - source: part-4/5-FileSystems.md - label: File Systems - - source: part-5/0_Abstract.md - label: Introduction - - source: part-5/1-MAC.md - label: Mandatory Access Control - - source: part-5/2-SystemD.md - label: SystemD - - source: part-5/3-SystemBus.md - label: SystemBus - - source: part-5/4-Services.md - label: System services and daemons - - source: part-5/5-AppFw.md - label: Application Framework - - source: part-5/App-flow.png - label: Application Framework Flow - - source: part-5/6-Utilities.md - label: Utilities - - source: part-5/7-Users.md - label: Users - - source: part-6/0_Abstract.md - label: Introduction - - source: part-6/App_signing_flow.png - label: App Signing Flow - - source: part-6/1-Installation.md - label: Installation - - source: part-6/2-PrivilegeManagement.md - label: Privilege management - - source: part-6/3-Signature.md - label: Signature - - source: part-6/4-Services.md - label: Services - - source: part-7/0_Abstract.md - label: Introduction - - source: part-7/1-BusAndConnectors.md - label: Bus and connectors - - source: part-7/2-Wireless.md - label: Wireless - - source: part-7/3-Cloud.md - label: Cloud - - source: part-8/0_Abstract.md - label: Introduction - - source: part-8/1-FOTA.md - label: FOTA - - source: part-8/2-SOTA.md - label: SOTA - - source: part-9/0_Abstract.md - label: Introduction diff --git a/content/tocs/architecture/section_flounder.yml b/content/tocs/architecture/section_flounder.yml index e38fb76..66b4fb8 100644 --- a/content/tocs/architecture/section_flounder.yml +++ b/content/tocs/architecture/section_flounder.yml @@ -13,7 +13,6 @@ books: id: security_blueprint-flounder url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources dst_prefix: security path: docs/security-blueprint-book.yml diff --git a/content/tocs/architecture/section_guppy.yml b/content/tocs/architecture/section_guppy.yml index 9e20d2f..65246cd 100644 --- a/content/tocs/architecture/section_guppy.yml +++ b/content/tocs/architecture/section_guppy.yml @@ -13,7 +13,6 @@ books: id: security_blueprint url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources dst_prefix: security path: docs/security-blueprint-book.yml diff --git a/content/tocs/architecture/section_master.yml b/content/tocs/architecture/section_master.yml index 9e20d2f..65246cd 100644 --- a/content/tocs/architecture/section_master.yml +++ b/content/tocs/architecture/section_master.yml @@ -13,7 +13,6 @@ books: id: security_blueprint url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources dst_prefix: security path: docs/security-blueprint-book.yml diff --git a/content/tocs/devguides/fetched_files.yml b/content/tocs/devguides/fetched_files.yml deleted file mode 100644 index 69f40e8..0000000 --- a/content/tocs/devguides/fetched_files.yml +++ /dev/null @@ -1,174 +0,0 @@ -############################################################################################################## -# GLOBAL DOCUMENT -# <any REPOSITORY option>: global setting -# repositories: array of objects with documents to fetchd -# -# REPOSITORY ENTRY: -# - -# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration) -# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration) -# git_name: repository name (%repo%) -# git_commit: git reference: revision, SHA1, branch... (%commit%) -# src_prefix: prefix prepended to %source% -# dst_prefix: prefix prepended to destination name -# documents: array of documents to fetch -# -# DOCUMENT ENTRY: -# source: subpath within repository (%source%) -# destination: local destination filename -# label|title: name within TOC -# edit|editURI: specific edition URI -# -# EXAMPLE: -# ------------------------------------ -# url: "GERRIT_FETCH" -# git_commit: "master" -# repositories: -# - -# git_name: src/foo -# src_prefix: docs -# dst_prefix: foodocs -# documents: -# - source: intro.md -# label: Introduction -# - source: topic/README.md -# destination: topic.md -# label: My Topic -# ------------------------------------ -############################################################################################################## - -url_fetch: GERRIT_FETCH -git_commit: AGL_GERRIT_BRANCH - -repositories: -- - git_name: AGL/meta-agl - documents: - - source: README-AGL.md - destination: AGL.md - label: Overview - - source: README.md - destination: meta-agl.md - label: meta-agl -- - git_name: AGL/meta-agl-demo - documents: - - source: README.md - destination: meta-agl-demo.md - label: meta-agl-demo -- - git_name: AGL/meta-agl-devel - documents: - - source: README.md - destination: meta-agl-devel.md - label: meta-agl-devel -- - url_fetch: https://iot.bzh/download/public/2016/%source% - dst_prefix: iotbzh2016 - documents: - - source: appfw/03-AGL-AppFW-Privileges-Management.pdf -- - url_fetch: "GITHUB_FETCH" - git_name: iotbzh/agl-documentation - git_commit: "master" - documents: - - source: host-configuration/docs/0_Abstract.md - - source: host-configuration/docs/1_Prerequisites.md - - source: host-configuration/docs/2_AGL_Application_Framework.md - - source: host-configuration/docs/3_Binding_Build_Example.md - - source: host-configuration/docs/4_AGL_XDS.md - - source: host-configuration/docs/5_Candevstudio.md -- - git_name: src/cmake-apps-module - src_prefix: "docs/dev_guide" - dst_prefix: "cmakeafbtemplates" - documents: - - source: 0_Abstract.md - - source: 1_Quickstart.md - - source: 2_project_architecture.md - - source: 3_advanced_usage.md - - source: 4_advanced_customization.md - - source: 5_autobuild.md -- - git_name: src/xds/xds-docs - src_prefix: "docs" - dst_prefix: "xds" - documents: - - source: part-1/0_Abstract.md - - source: part-1/1_install-xds-server.md - - source: part-1/1-1_install-xds-server-docker.md - - source: part-1/1-2_install-xds-server-vm.md - - source: part-1/1-3_install-xds-server-native.md - - source: part-1/2_install-client.md - - source: part-1/3_install-sdks.md - - source: part-1/4-1_build-first-app-setup.md - - source: part-1/4-2_build-first-app-cmd.md - - source: part-1/4-3_build-first-app-dashboard.md - - source: part-1/4-4_build-first-app-ide.md - - source: part-1/4_build-first-app.md - - source: part-1/5-1_debug-first-app-config.md - - source: part-1/5-2_debug-first-app-cmd.md - - source: part-1/5-3_debug-first-app-ide.md - - source: part-1/5_debug-first-app.md - - source: part-1/pictures/nb_new-project-1.png - - source: part-1/pictures/nb_new-project-2.png - - source: part-1/pictures/nb_new-project-3.png - - source: part-1/pictures/nb_new-project-4.png - - source: part-1/pictures/nb_new-project-5.png - - source: part-1/pictures/nb_newtool.png - - source: part-1/pictures/nb_project_debug-1.png - - source: part-1/pictures/nb_xds_options.png - - source: part-1/pictures/xds-block-chain.png - - source: part-1/pictures/xds-block-diagram.png - - source: part-1/pictures/xds-conf.png - - source: part-1/pictures/xds-dashboard-icon-1.png - - source: part-1/pictures/xds-dashboard-icon-2.png - - source: part-1/pictures/xds-dashboard-icon-3.png - - source: part-1/pictures/xds-dashboard-prj-1.png - - source: part-1/pictures/xds-dashboard-prj-2.png - - source: part-1/pictures/xds-dashboard-sdks-install.png - - source: part-1/pictures/xds-dashboard-sdks-mgt.png - - source: part-2/0_Abstract.md - - source: part-2/1_Prerequisites.md - - source: part-2/1_xds-server/0_abstract.md - - source: part-2/1_xds-server/1_build.md - - source: part-2/1_xds-server/2_config.md - - source: part-2/1_xds-server/3_how-to-run.md - - source: part-2/1_xds-server/4_debug.md - - source: part-2/1_xds-server/5_test.md - - source: part-2/2_xds-agent/0_abstract.md - - source: part-2/2_xds-agent/1_build.md - - source: part-2/2_xds-agent/2_config.md - - source: part-2/2_xds-agent/3_start.md - - source: part-2/2_xds-agent/4_debug.md - - source: part-2/3_xds-cli/0_abstract.md - - source: part-2/3_xds-cli/1_build.md - - source: part-2/3_xds-cli/2_config.md - - source: part-2/3_xds-cli/3_commands.md - - source: part-2/3_xds-cli/4_debug.md - - source: part-2/4_xds-gdb/0_abstract.md - - source: part-2/4_xds-gdb/1_build.md - - source: part-2/4_xds-gdb/2_config.md - - source: part-2/4_xds-gdb/3_debug.md - -- - url_fetch: GITHUB_FETCH - url_edit: GITHUB_EDIT - git_name: baylibre/agl-docs-baylibre - git_commit: master - documents: - - source: CIAT/training/How_to_write_your_own_tests_for_AGL.pdf - - source: CIAT/training/Hands_on_lab_documentation.pdf -- - git_name: apps/app-controller-submodule - src_prefix: docs - dst_prefix: ctrler - documents: - - source: Usage.md - label: Usage - - source: configSample.md - label: Configuration Sample - - source: controller.md - label: Installation - - source: controllerConfig.md - label: Binding Configuration diff --git a/content/tocs/devguides/section_flounder.yml b/content/tocs/devguides/section_flounder.yml index 8f1036e..a18fb37 100644 --- a/content/tocs/devguides/section_flounder.yml +++ b/content/tocs/devguides/section_flounder.yml @@ -49,7 +49,6 @@ books: name: Continuous Integration - Automated Testing (CIAT) url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/continuous-integration-book.yml books: diff --git a/content/tocs/devguides/section_guppy.yml b/content/tocs/devguides/section_guppy.yml index a1f86b9..7408b41 100644 --- a/content/tocs/devguides/section_guppy.yml +++ b/content/tocs/devguides/section_guppy.yml @@ -53,7 +53,6 @@ books: name: Continuous Integration - Automated Testing (CIAT) url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/continuous-integration-book.yml books: diff --git a/content/tocs/devguides/section_master.yml b/content/tocs/devguides/section_master.yml index 6cae842..cfe3089 100644 --- a/content/tocs/devguides/section_master.yml +++ b/content/tocs/devguides/section_master.yml @@ -52,7 +52,6 @@ books: name: Continuous Integration - Automated Testing (CIAT) url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/continuous-integration-book.yml books: diff --git a/content/tocs/devguides/toc_dev_en.yml b/content/tocs/devguides/toc_dev_en.yml index f9bad98..551ae12 100644 --- a/content/tocs/devguides/toc_dev_en.yml +++ b/content/tocs/devguides/toc_dev_en.yml @@ -245,6 +245,18 @@ children: - url: reference/ctrler/configSample.html - + name: AFB Helper functions reference + children: + - url: reference/afb-helpers/usage.html + - url: reference/afb-helpers/afb-timer.html + - url: reference/afb-helpers/curl-wrap.html + - url: reference/afb-helpers/escape.html + - url: reference/afb-helpers/filescan-utils.html + - url: reference/afb-helpers/qafbwebsocketclient.html + - url: reference/afb-helpers/json.html + - url: reference/afb-helpers/wrap-json.html + +- name: "Continuous Integration - Automated Testing (CIAT)" children: - diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml deleted file mode 100644 index e1ea28b..0000000 --- a/content/tocs/getting_started/fetched_files.yml +++ /dev/null @@ -1,120 +0,0 @@ -############################################################################################################## -# GLOBAL DOCUMENT -# <any REPOSITORY option>: global setting -# repositories: array of objects with documents to fetchd -# -# REPOSITORY ENTRY: -# - -# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration) -# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration) -# git_name: repository name (%repo%) -# git_commit: git reference: revision, SHA1, branch... (%commit%) -# src_prefix: prefix prepended to %source% -# dst_prefix: prefix prepended to destination name -# documents: array of documents to fetch -# -# DOCUMENT ENTRY: -# source: subpath within repository (%source%) -# destination: local destination filename -# label|title: name within TOC -# edit|editURI: specific edition URI -# -# EXAMPLE: -# ------------------------------------ -# url: "GERRIT_FETCH" -# git_commit: "master" -# repositories: -# - -# git_name: src/foo -# src_prefix: docs -# dst_prefix: foodocs -# documents: -# - source: intro.md -# label: Introduction -# - source: topic/README.md -# destination: topic.md -# label: My Topic -# ------------------------------------ -############################################################################################################## - -#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source) - -url_fetch: GERRIT_FETCH -git_commit: AGL_GERRIT_BRANCH - -repositories: -- - url_fetch: AGL_GITHUB_FETCH - url_edit: AGL_GITHUB_EDIT - git_name: automotive-grade-linux/docs-sources - git_commit: AGL_GITHUB_BRANCH - src_prefix: docs/getting-started - documents : - - source: getting-started-welcome.md - label: Overview - - source: app-workflow-intro.md - label: Overview - - source: app-workflow-image.md - label: Download or Build Your Image - - source: app-workflow-sdk.md - label: Download or Build Your SDK Installer - - source: app-workflow-bootables.md - label: Create Bootable Media - - source: app-workflow-boot.md - label: Boot the Image on the Board - - source: app-workflow-prep-app.md - label: Get Ready to Create Your Application - - source: app-workflow-build-app.md - label: Create and Build the Application - - source: app-workflow-deploy-app.md - label: Deploy the Application to the Board - - source: app-workflow-debug-app.md - label: Debug the Application - - source: images/app-developer-workflow.png - destination: images/app-developer-workflow.png - - source: image-workflow-intro.md - label: Overview - - source: image-workflow-prep-host.md - label: Preparing Your Build Host - - source: image-workflow-download-sw.md - label: Downloading AGL Software - - source: image-workflow-initialize-build-environment.md - label: Initializing Your Build Environment - - source: image-workflow-cust-build.md - label: Customizing Your Build - - source: image-workflow-build.md - label: Building the AGL Image - - source: machines/intel.md - label: Building for Most Intel 64-Bit Hardware Platforms - - source: machines/qemu.md - label: Building for Emulation - - source: machines/renesas.md - label: Building for Supported Renesas Boards - - source: machines/raspberrypi.md - label: Building for Raspberry PI 2 or 3 - - source: images/image-developer-workflow.png - destination: images/image-developer-workflow.png - - source: troubleshooting.md - label: Generic issues - - source: machines/images/RaspberryPi2-ModelB-debug-serial-cable.png - destination: machines/images/RaspberryPi2-ModelB-debug-serial-cable.png - - source: docker-container-setup.md - label: Overview -- - git_name: apps/homescreen - src_prefix: homescreen/docs - dst_prefix: homescreen - documents: - - source: index.md - label: Overview - - source: pictures/dashboard.png - destination: pictures/dashboard.png - - source: pictures/homescreen_applauncher.png - destination: pictures/homescreen_applauncher.png - - source: pictures/hvac.png - destination: pictures/hvac.png - - source: pictures/phone.png - destination: pictures/phone.png - - source: pictures/settings.png - destination: pictures/settings.png - diff --git a/content/tocs/getting_started/section_flounder.yml b/content/tocs/getting_started/section_flounder.yml index f22e8c1..51644bf 100644 --- a/content/tocs/getting_started/section_flounder.yml +++ b/content/tocs/getting_started/section_flounder.yml @@ -7,7 +7,6 @@ books: id: flounder-image-development-workflow url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/getting-started-book.yml - diff --git a/content/tocs/getting_started/section_guppy.yml b/content/tocs/getting_started/section_guppy.yml index b0c0230..4777c8d 100644 --- a/content/tocs/getting_started/section_guppy.yml +++ b/content/tocs/getting_started/section_guppy.yml @@ -7,7 +7,6 @@ books: id: image-development-workflow url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/getting-started-book.yml - diff --git a/content/tocs/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml index b0c0230..4777c8d 100644 --- a/content/tocs/getting_started/section_master.yml +++ b/content/tocs/getting_started/section_master.yml @@ -7,7 +7,6 @@ books: id: image-development-workflow url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/getting-started-book.yml - diff --git a/content/tocs/hardware/fetched_files.yml b/content/tocs/hardware/fetched_files.yml deleted file mode 100644 index f1decf7..0000000 --- a/content/tocs/hardware/fetched_files.yml +++ /dev/null @@ -1,56 +0,0 @@ -############################################################################################################## -# GLOBAL DOCUMENT -# <any REPOSITORY option>: global setting -# repositories: array of objects with documents to fetchd -# -# REPOSITORY ENTRY: -# - -# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration) -# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration) -# git_name: repository name (%repo%) -# git_commit: git reference: revision, SHA1, branch... (%commit%) -# src_prefix: prefix prepended to %source% -# dst_prefix: prefix prepended to destination name -# documents: array of documents to fetch -# -# DOCUMENT ENTRY: -# source: subpath within repository (%source%) -# destination: local destination filename -# label|title: name within TOC -# edit|editURI: specific edition URI -# -# EXAMPLE: -# ------------------------------------ -# url: "GERRIT_FETCH" -# git_commit: "master" -# repositories: -# - -# git_name: src/foo -# src_prefix: docs -# dst_prefix: foodocs -# documents: -# - source: intro.md -# label: Introduction -# - source: topic/README.md -# destination: topic.md -# label: My Topic -# ------------------------------------ -############################################################################################################## - -#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source) - -url_fetch: "GERRIT_FETCH" -git_commit: "AGL_GERRIT_BRANCH" - -repositories: -- - git_name: AGL/meta-renesas-rcar-gen3 - dst_prefix: renesas-gen3 - documents: - - source: meta-rcar-gen3/README - destination: gen3.md - label: meta-rcar-gen3 layer - - source: meta-rcar-gen3/README.proprietary - destination: proprietary.md - label: Proprietary drivers - diff --git a/content/tocs/howto/section_guppy.yml b/content/tocs/howto/section_guppy.yml index b5af902..ba3d899 100644 --- a/content/tocs/howto/section_guppy.yml +++ b/content/tocs/howto/section_guppy.yml @@ -7,7 +7,6 @@ books: id: howto-add-docs url_fetch: GITHUB_FETCH url_edit: GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/handle-docs-book.yml diff --git a/content/tocs/howto/section_master.yml b/content/tocs/howto/section_master.yml index b5af902..ba3d899 100644 --- a/content/tocs/howto/section_master.yml +++ b/content/tocs/howto/section_master.yml @@ -7,7 +7,6 @@ books: id: howto-add-docs url_fetch: GITHUB_FETCH url_edit: GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/handle-docs-book.yml diff --git a/content/tocs_flounder/apis_services/toc_dev_en.yml b/content/tocs_flounder/apis_services/toc_dev_en.yml new file mode 100644 index 0000000..f793a51 --- /dev/null +++ b/content/tocs_flounder/apis_services/toc_dev_en.yml @@ -0,0 +1,176 @@ +####################################################################### +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes +# +# +############################ SYNTAX ################################### +# GLOBAL OPTIONS: +# name: TOC (page) title +# template: name of template to use for this page - use 'generated_index.html' if unknown +# children: array of TOC entries +# +# TOC Entry: +# name: TOC entry (level 1) +# children: +# - +# name: optional name for TOC entry (default: use URL FrontMatter info) +# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js: +# - +# name: ... +# url: ... +# ... +# +# EXAMPLE: +# ------------------------------- +# name: Developer Guides +# template: generated_index.html +# children: +# - +# name: Application Framework +# children: +# - url: reference/af-main/overview.html +# - url: reference/af-main/afm-system-daemon.html +# - url: reference/af-main/afm-user-daemon.html +# ------------------------------- +####################################################################### + +name: Developer Guides +template: generated_index.html +children: +- + name: Application Framework + children: + - url: reference/af-main/0-introduction.html + - url: reference/af-main/1-afm-daemons.html + - url: reference/af-main/2-widgets.html + - url: reference/af-main/2.1-widgets.html + - url: reference/af-main/2.2-config.xml.html + - url: reference/af-main/3-permissions.html + - url: reference/af-main/4-quick-tutorial.html +- + name: Application Framework Binder + children: + - url: reference/af-binder/afb-overview.html + - url: reference/af-binder/afb-daemon-vocabulary.html + - url: reference/af-binder/afb-binding-writing.html + - name: Binder references + children: + - url: reference/af-binder/reference-v3/types-and-globals.html + - url: reference/af-binder/reference-v3/macro-log.html + - url: reference/af-binder/reference-v3/func-api.html + - url: reference/af-binder/reference-v3/func-req.html + - url: reference/af-binder/reference-v3/func-event.html + - url: reference/af-binder/reference-v3/func-daemon.html + - url: reference/af-binder/reference-v3/func-service.html + - url: reference/af-binder/afb-events-guide.html + - url: reference/af-binder/afb-application-writing.html + - name: Annexes + children: + - url: reference/af-binder/afb-migration-to-binding-v3.html + - url: reference/af-binder/protocol-x-afb-ws-json1.html + - url: reference/af-binder/afb-desktop-package.html + - url: reference/af-binder/afb-daemon-options.html + - url: reference/af-binder/afb-daemon-debugging.html + - url: reference/af-binder/legacy/afb-migration-v1-to-v2.html + - url: reference/af-binder/legacy/afb-binding-v2-references.html + - url: reference/af-binder/REVISIONS.html + +- + name: AGL Test Framework + children: + - url: reference/afb-test/Installation.html + - url: reference/afb-test/write-the-tests.html + - url: reference/afb-test/the-test-widget.html + - url: reference/afb-test/launch-the-tests.html + - url: reference/afb-test/tests-examples.html + - name: References + children: + - url: reference/afb-test/binding-test-functions.html + - url: reference/afb-test/binding-assert-functions.html + - url: reference/afb-test/test-framework-functions.html + - name: LuaUnit Assertion Functions + children: + - url: reference/afb-test/general-assertions.html + - url: reference/afb-test/value-assertions.html + - url: reference/afb-test/scientific-assertions.html + - url: reference/afb-test/string-assertions.html + - url: reference/afb-test/error-assertions.html + - url: reference/afb-test/type-assertions.html + - url: reference/afb-test/table-assertions.html + +- + name: Message Signaling + children: + - url: reference/signaling/architecture.html + - name: Low level CAN service Guide + children: + - url: reference/signaling/low-can-architecture.html + - url: reference/signaling/low-can-installation-guide.html + - url: reference/signaling/low-can-usage-guide.html + - name: High level ViWi service Guide + children: + - url: reference/signaling/high-viwi-architecture.html + - url: reference/signaling/high-viwi-install-usage-guide.html + - name: Signal Composer service Guide + children: + - url: reference/signaling/signal-composer-architecture.html + - url: reference/signaling/signal-composer-configuration.html + - url: reference/signaling/signal-composer-plugins.html + - url: reference/signaling/signal-composer-api.html + - name: Developer Guidelines + url: reference/iotbzh2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf + - name: CAN Signaling Benchmark + url: reference/iotbzh2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf + - name: CanDevStudio Quickstart + children: + - name: Usage Guide + url: reference/candevstudio/docs/1_Usage.html + - name: Bringing up a CAN device using socketcan backend + url: reference/candevstudio/docs/2_can_device_socketcan_backend.html + - name: Add a CAN device in CANdevStudio + url: reference/candevstudio/docs/3_Add_CAN_Device.html + - name: Configure a CanRawSender node + url: reference/candevstudio/docs/4_Configure_CanRawSender_Node.html + - name: Using CanRawView + url: reference/candevstudio/docs/5_Using_CanRawView.html + - url: reference/signaling/resources.html +- + name: Audio Framework + children: + - url: reference/audio/bluez-alsa.html + - url: reference/audio/pulseaudio-module-4a.html + - name: 4a Framework + children: + - url: reference/audio/4a-framework/README.html + - url: reference/audio/4a-framework/concepts.html + - url: reference/audio/4a-framework/components.html + - name: high-level-api + children: + - url: reference/audio/high-level-api/README.html + - url: reference/audio/high-level-api/kickstart.html + - url: reference/audio/high-level-api/reference.html + - name: Tips And Tricks + children: + - url: reference/audio/high-level-api/TipsAndTricks/AdjustVolumes.html + - url: reference/audio/high-level-api/TipsAndTricks/4aTools.html + - url: reference/audio/high-level-api/TipsAndTricks/Devices.html + - url: reference/audio/high-level-api/TipsAndTricks/HALs.html +- + name: HMI Framework + children: + - + name: Home Screen Developper Guide + url: reference/hmi-framework/3_1-HomeScreen-Guide.html + - + name: Window Manager Developper Guide + url: reference/hmi-framework/3_2-WindowManager-Guide.html + - + name: Sound Manager Developper Guide + url: reference/hmi-framework/3_3-SoundManager-Guide.html +- + name: HomeScreen (old) + children: + - url: reference/homescreen/homescreen_api.html + + diff --git a/content/tocs_flounder/architecture/toc_dev_en.yml b/content/tocs_flounder/architecture/toc_dev_en.yml new file mode 100644 index 0000000..25c6f36 --- /dev/null +++ b/content/tocs_flounder/architecture/toc_dev_en.yml @@ -0,0 +1,106 @@ +####################################################################### +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes +# +# +############################ SYNTAX ################################### +# GLOBAL OPTIONS: +# name: TOC (page) title +# template: name of template to use for this page - use 'generated_index.html' if unknown +# children: array of TOC entries +# +# TOC Entry: +# name: TOC entry (level 1) +# children: +# - +# name: optional name for TOC entry (default: use URL FrontMatter info) +# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js: +# - +# name: ... +# url: ... +# ... +# +# EXAMPLE: +# ------------------------------- +# name: Developer Guides +# template: generated_index.html +# children: +# - +# name: Application Framework +# children: +# - url: reference/af-main/overview.html +# - url: reference/af-main/afm-system-daemon.html +# - url: reference/af-main/afm-user-daemon.html +# ------------------------------- +####################################################################### + +name: Architecture Guides +template: generated_index.html +children: +- + name: AGL Specifications + children: + - + name: Automotive Grade Linux Requirements Specifications + url: reference/AGL_Specifications/agl_spec_v1.0_final.pdf +- + name: Security Blueprint + children: + - url: reference/security/README.html + - name: Part-1 Hardware + children: + - url: reference/security/part-1/0_Abstract.html + - name: Part-2 Secure Boot + children: + - url: reference/security/part-2/0_Abstract.html + - url: reference/security/part-2/1-Image.html + - url: reference/security/part-2/2-Communication-modes.html + - url: reference/security/part-2/3-Consoles.html + - name: Part-3 Hypervisor + children: + - url: reference/security/part-3/0_Abstract.html + - name: Part-4 Kernel + children: + - url: reference/security/part-4/0_Abstract.html + - url: reference/security/part-4/1-General.html + - url: reference/security/part-4/2-Memory.html + - url: reference/security/part-4/3-Consoles.html + - url: reference/security/part-4/4-Debug.html + - url: reference/security/part-4/5-FileSystems.html + - name: Part-5 Platform + children: + - url: reference/security/part-5/0_Abstract.html + - url: reference/security/part-5/1-MAC.html + - url: reference/security/part-5/2-SystemD.html + - url: reference/security/part-5/3-SystemBus.html + - url: reference/security/part-5/4-Services.html + - url: reference/security/part-5/5-AppFw.html + - url: reference/security/part-5/6-Utilities.html + - url: reference/security/part-5/7-Users.html + - name: Part-6 Application + children: + - url: reference/security/part-6/0_Abstract.html + - url: reference/security/part-6/1-Installation.html + - url: reference/security/part-6/2-PrivilegeManagement.html + - url: reference/security/part-6/3-Signature.html + - url: reference/security/part-6/4-Services.html + - name: Part-7 Connectivity + children: + - url: reference/security/part-7/0_Abstract.html + - url: reference/security/part-7/1-BusAndConnectors.html + - url: reference/security/part-7/2-Wireless.html + - url: reference/security/part-7/3-Cloud.html + - name: Part-8 Update + children: + - url: reference/security/part-8/0_Abstract.html + - url: reference/security/part-8/1-FOTA.html + - url: reference/security/part-8/2-SOTA.html + - name: Part-9 Secure development + children: + - url: reference/security/part-9/0_Abstract.html + - name: Annexes + children: + - url: reference/security/annexes/0_Abstract.html + - url: reference/security/annexes/ConfigNotes.html + - url: reference/security/annexes/todoNotes.html diff --git a/content/tocs_flounder/devguides/toc_dev_en.yml b/content/tocs_flounder/devguides/toc_dev_en.yml new file mode 100644 index 0000000..6e8fc75 --- /dev/null +++ b/content/tocs_flounder/devguides/toc_dev_en.yml @@ -0,0 +1,243 @@ +####################################################################### +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes +# +# +############################ SYNTAX ################################### +# GLOBAL OPTIONS: +# name: TOC (page) title +# template: name of template to use for this page - use 'generated_index.html' if unknown +# children: array of TOC entries +# +# TOC Entry: +# name: TOC entry (level 1) +# children: +# - +# name: optional name for TOC entry (default: use URL FrontMatter info) +# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js: +# - +# name: ... +# url: ... +# ... +# +# EXAMPLE: +# ------------------------------- +# name: Developer Guides +# template: generated_index.html +# children: +# - +# name: Application Framework +# children: +# - url: reference/af-main/overview.html +# - url: reference/af-main/afm-system-daemon.html +# - url: reference/af-main/afm-user-daemon.html +# ------------------------------- +####################################################################### + +name: Developer Guides +template: generated_index.html +children: +- + name: Yocto layers + children: + - url: reference/AGL.html + - url: reference/meta-agl.html + - url: reference/meta-agl-demo.html + - url: reference/meta-agl-devel.html +- + name: Host Configuration + children: + - + name: Abstract + url: reference/host-configuration/docs/0_Abstract.html + - + name: Prerequisites + url: reference/host-configuration/docs/1_Prerequisites.html + - + name: AGL Application Framework + url: reference/host-configuration/docs/2_AGL_Application_Framework.html + - + name: Binding Build Example + url: reference/host-configuration/docs/3_Binding_Build_Example.html + - + name: AGL XDS + url: reference/host-configuration/docs/4_AGL_XDS.html + - + name: CanDevStudio + url: reference/host-configuration/docs/5_Candevstudio.html +- + name: App-Templates Submodule + children: + - + name: CMake templates Guide + url: reference/app-templates/docs/0-App-templates-usage.html +- + name: "X(cross) Development System: User's Guide" + children: + - + name: Getting Started + url: reference/xds/part-1/0_Abstract.html + - + name: Installing xds-server + children: + - + name: Installation + url: reference/xds/part-1/1_install-xds-server.html + - + name: Based on Docker container + url: reference/xds/part-1/1-1_install-xds-server-docker.html + - + name: Based on Virtual Machine appliance + url: reference/xds/part-1/1-2_install-xds-server-vm.html + - + name: Native installation + url: reference/xds/part-1/1-3_install-xds-server-native.html + - + name: Installing xds client tools + url: reference/xds/part-1/2_install-client.html + - + name: Installing AGL SDKs + url: reference/xds/part-1/3_install-sdks.html + - + name: Create your first AGL application + children: + - + name: Prerequisites + url: reference/xds/part-1/4_build-first-app.html + - + name: Setup + url: reference/xds/part-1/4-1_build-first-app-setup.html + - + name: Build using command line tool + url: reference/xds/part-1/4-2_build-first-app-cmd.html + - + name: Build using XDS Dashboard + url: reference/xds/part-1/4-3_build-first-app-dashboard.html + - + name: Build using a source code editor / IDE + url: reference/xds/part-1/4-4_build-first-app-ide.html + - + name: Debug your first AGL application + children: + - + name: Prerequisites + url: reference/xds/part-1/5_debug-first-app.html + - + name: Configuration + url: reference/xds/part-1/5-1_debug-first-app-config.html + - + name: xds-gdb from command line + url: reference/xds/part-1/5-2_debug-first-app-cmd.html + - + name: xds-gdb within an IDE + url: reference/xds/part-1/5-3_debug-first-app-ide.html + +- + name: "X(cross) Development System: Internals" + children: + - + name: Abstract + url: reference/xds/part-2/0_Abstract.html + - + name: Prerequisites + url: reference/xds/part-2/1_Prerequisites.html + - + name: XDS-server + children: + - + name: Abstract + url: reference/xds/part-2/1_xds-server/0_abstract.html + - + name: Build from scratch + url: reference/xds/part-2/1_xds-server/1_build.html + - + name: Configuration + url: reference/xds/part-2/1_xds-server/2_config.html + - + name: How to run + url: reference/xds/part-2/1_xds-server/3_how-to-run.html + - + name: Debugging + url: reference/xds/part-2/1_xds-server/4_debug.html + - + name: Test + url: reference/xds/part-2/1_xds-server/5_test.html + - + name: XDS-agent + children: + - + name: Abstract + url: reference/xds/part-2/2_xds-agent/0_abstract.html + - + name: Build from scratch + url: reference/xds/part-2/2_xds-agent/1_build.html + - + name: Configuration + url: reference/xds/part-2/2_xds-agent/2_config.html + - + name: Start + url: reference/xds/part-2/2_xds-agent/3_start.html + - + name: Debugging + url: reference/xds/part-2/2_xds-agent/4_debug.html + - + name: XDS-cli + children: + - + name: Abstract + url: reference/xds/part-2/3_xds-cli/0_abstract.html + - + name: Build from scratch + url: reference/xds/part-2/3_xds-cli/1_build.html + - + name: Configuration + url: reference/xds/part-2/3_xds-cli/2_config.html + - + name: CLI Commands + url: reference/xds/part-2/3_xds-cli/3_commands.html + - + name: Debugging + url: reference/xds/part-2/3_xds-cli/4_debug.html + - + name: XDS-gdb + children: + - + name: Abstract + url: reference/xds/part-2/4_xds-gdb/0_abstract.html + - + name: Build from scratch + url: reference/xds/part-2/4_xds-gdb/1_build.html + - + name: Configuration + url: reference/xds/part-2/4_xds-gdb/2_config.html + - + name: Debugging + url: reference/xds/part-2/4_xds-gdb/3_debug.html +- + name: Guides + children: + - + name: AppFW - Privileges Management + url: reference/iotbzh2016/appfw/03-AGL-AppFW-Privileges-Management.pdf + +- + name: Controller Guide + children: + - url: reference/ctrler/controller.html + - url: reference/ctrler/controllerConfig.html + - url: reference/ctrler/Usage.html + - url: reference/ctrler/configSample.html + +- + name: "Continuous Integration - Automated Testing (CIAT)" + children: + - + name: Training + children: + - + name: "How to write tests (overview slides)" + url: reference/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf + - + name: "How to write tests (detailed)" + url: reference/CIAT/training/Hands_on_lab_documentation.pdf diff --git a/content/tocs_flounder/getting_started/toc_dev_en.yml b/content/tocs_flounder/getting_started/toc_dev_en.yml new file mode 100644 index 0000000..a534c61 --- /dev/null +++ b/content/tocs_flounder/getting_started/toc_dev_en.yml @@ -0,0 +1,64 @@ +####################################################################### +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes +# +# +############################ SYNTAX ################################### +# GLOBAL OPTIONS: +# name: TOC (page) title +# template: name of template to use for this page - use 'generated_index.html' if unknown +# children: array of TOC entries +# +# TOC Entry: +# name: TOC entry (level 1) +# children: +# - +# name: optional name for TOC entry (default: use URL FrontMatter info) +# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js: +# - +# name: ... +# url: ... +# ... +# +# EXAMPLE: +# ------------------------------- +# name: Developer Guides +# template: generated_index.html +# children: +# - +# name: Application Framework +# children: +# - url: reference/af-main/overview.html +# - url: reference/af-main/afm-system-daemon.html +# - url: reference/af-main/afm-user-daemon.html +# ------------------------------- +####################################################################### + +name: Getting started +template: generated_index.html +children: +- + name: Getting Started + children: + - url: reference/source-code.html + - url: reference/customize_bitbake_conf.html + - url: reference/machines/intel.html + - url: reference/machines/qemu.html + - url: reference/machines/R-Car-Starter-Kit-gen3.html + - url: reference/machines/raspberrypi.html +- + name: HomeScreen + children: + - url: reference/homescreen/index.html +- + name: Troubleshooting + children: + - url: reference/troubleshooting.html + - url: reference/footers/intel-footer.html + - url: reference/footers/raspberrypi-footer.html +- + name: SDK + children: + - url: reference/setup-sdk-environment.html + diff --git a/content/tocs_flounder/hardware/toc_dev_en.yml b/content/tocs_flounder/hardware/toc_dev_en.yml new file mode 100644 index 0000000..6c49ed8 --- /dev/null +++ b/content/tocs_flounder/hardware/toc_dev_en.yml @@ -0,0 +1,45 @@ +####################################################################### +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes +# +# +############################ SYNTAX ################################### +# GLOBAL OPTIONS: +# name: TOC (page) title +# template: name of template to use for this page - use 'generated_index.html' if unknown +# children: array of TOC entries +# +# TOC Entry: +# name: TOC entry (level 1) +# children: +# - +# name: optional name for TOC entry (default: use URL FrontMatter info) +# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js: +# - +# name: ... +# url: ... +# ... +# +# EXAMPLE: +# ------------------------------- +# name: Developer Guides +# template: generated_index.html +# children: +# - +# name: Application Framework +# children: +# - url: reference/af-main/overview.html +# - url: reference/af-main/afm-system-daemon.html +# - url: reference/af-main/afm-user-daemon.html +# ------------------------------- +####################################################################### + +name: Hardware Support +template: generated_index.html +children: +- + name: Renesas Gen3 Boards + children: + - url: reference/renesas-gen3/gen3.html + - url: reference/renesas-gen3/proprietary.html diff --git a/content/tocs_guppy/apis_services/toc_dev_en.yml b/content/tocs_guppy/apis_services/toc_dev_en.yml new file mode 100644 index 0000000..f793a51 --- /dev/null +++ b/content/tocs_guppy/apis_services/toc_dev_en.yml @@ -0,0 +1,176 @@ +####################################################################### +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes +# +# +############################ SYNTAX ################################### +# GLOBAL OPTIONS: +# name: TOC (page) title +# template: name of template to use for this page - use 'generated_index.html' if unknown +# children: array of TOC entries +# +# TOC Entry: +# name: TOC entry (level 1) +# children: +# - +# name: optional name for TOC entry (default: use URL FrontMatter info) +# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js: +# - +# name: ... +# url: ... +# ... +# +# EXAMPLE: +# ------------------------------- +# name: Developer Guides +# template: generated_index.html +# children: +# - +# name: Application Framework +# children: +# - url: reference/af-main/overview.html +# - url: reference/af-main/afm-system-daemon.html +# - url: reference/af-main/afm-user-daemon.html +# ------------------------------- +####################################################################### + +name: Developer Guides +template: generated_index.html +children: +- + name: Application Framework + children: + - url: reference/af-main/0-introduction.html + - url: reference/af-main/1-afm-daemons.html + - url: reference/af-main/2-widgets.html + - url: reference/af-main/2.1-widgets.html + - url: reference/af-main/2.2-config.xml.html + - url: reference/af-main/3-permissions.html + - url: reference/af-main/4-quick-tutorial.html +- + name: Application Framework Binder + children: + - url: reference/af-binder/afb-overview.html + - url: reference/af-binder/afb-daemon-vocabulary.html + - url: reference/af-binder/afb-binding-writing.html + - name: Binder references + children: + - url: reference/af-binder/reference-v3/types-and-globals.html + - url: reference/af-binder/reference-v3/macro-log.html + - url: reference/af-binder/reference-v3/func-api.html + - url: reference/af-binder/reference-v3/func-req.html + - url: reference/af-binder/reference-v3/func-event.html + - url: reference/af-binder/reference-v3/func-daemon.html + - url: reference/af-binder/reference-v3/func-service.html + - url: reference/af-binder/afb-events-guide.html + - url: reference/af-binder/afb-application-writing.html + - name: Annexes + children: + - url: reference/af-binder/afb-migration-to-binding-v3.html + - url: reference/af-binder/protocol-x-afb-ws-json1.html + - url: reference/af-binder/afb-desktop-package.html + - url: reference/af-binder/afb-daemon-options.html + - url: reference/af-binder/afb-daemon-debugging.html + - url: reference/af-binder/legacy/afb-migration-v1-to-v2.html + - url: reference/af-binder/legacy/afb-binding-v2-references.html + - url: reference/af-binder/REVISIONS.html + +- + name: AGL Test Framework + children: + - url: reference/afb-test/Installation.html + - url: reference/afb-test/write-the-tests.html + - url: reference/afb-test/the-test-widget.html + - url: reference/afb-test/launch-the-tests.html + - url: reference/afb-test/tests-examples.html + - name: References + children: + - url: reference/afb-test/binding-test-functions.html + - url: reference/afb-test/binding-assert-functions.html + - url: reference/afb-test/test-framework-functions.html + - name: LuaUnit Assertion Functions + children: + - url: reference/afb-test/general-assertions.html + - url: reference/afb-test/value-assertions.html + - url: reference/afb-test/scientific-assertions.html + - url: reference/afb-test/string-assertions.html + - url: reference/afb-test/error-assertions.html + - url: reference/afb-test/type-assertions.html + - url: reference/afb-test/table-assertions.html + +- + name: Message Signaling + children: + - url: reference/signaling/architecture.html + - name: Low level CAN service Guide + children: + - url: reference/signaling/low-can-architecture.html + - url: reference/signaling/low-can-installation-guide.html + - url: reference/signaling/low-can-usage-guide.html + - name: High level ViWi service Guide + children: + - url: reference/signaling/high-viwi-architecture.html + - url: reference/signaling/high-viwi-install-usage-guide.html + - name: Signal Composer service Guide + children: + - url: reference/signaling/signal-composer-architecture.html + - url: reference/signaling/signal-composer-configuration.html + - url: reference/signaling/signal-composer-plugins.html + - url: reference/signaling/signal-composer-api.html + - name: Developer Guidelines + url: reference/iotbzh2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf + - name: CAN Signaling Benchmark + url: reference/iotbzh2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf + - name: CanDevStudio Quickstart + children: + - name: Usage Guide + url: reference/candevstudio/docs/1_Usage.html + - name: Bringing up a CAN device using socketcan backend + url: reference/candevstudio/docs/2_can_device_socketcan_backend.html + - name: Add a CAN device in CANdevStudio + url: reference/candevstudio/docs/3_Add_CAN_Device.html + - name: Configure a CanRawSender node + url: reference/candevstudio/docs/4_Configure_CanRawSender_Node.html + - name: Using CanRawView + url: reference/candevstudio/docs/5_Using_CanRawView.html + - url: reference/signaling/resources.html +- + name: Audio Framework + children: + - url: reference/audio/bluez-alsa.html + - url: reference/audio/pulseaudio-module-4a.html + - name: 4a Framework + children: + - url: reference/audio/4a-framework/README.html + - url: reference/audio/4a-framework/concepts.html + - url: reference/audio/4a-framework/components.html + - name: high-level-api + children: + - url: reference/audio/high-level-api/README.html + - url: reference/audio/high-level-api/kickstart.html + - url: reference/audio/high-level-api/reference.html + - name: Tips And Tricks + children: + - url: reference/audio/high-level-api/TipsAndTricks/AdjustVolumes.html + - url: reference/audio/high-level-api/TipsAndTricks/4aTools.html + - url: reference/audio/high-level-api/TipsAndTricks/Devices.html + - url: reference/audio/high-level-api/TipsAndTricks/HALs.html +- + name: HMI Framework + children: + - + name: Home Screen Developper Guide + url: reference/hmi-framework/3_1-HomeScreen-Guide.html + - + name: Window Manager Developper Guide + url: reference/hmi-framework/3_2-WindowManager-Guide.html + - + name: Sound Manager Developper Guide + url: reference/hmi-framework/3_3-SoundManager-Guide.html +- + name: HomeScreen (old) + children: + - url: reference/homescreen/homescreen_api.html + + diff --git a/content/tocs_guppy/architecture/toc_dev_en.yml b/content/tocs_guppy/architecture/toc_dev_en.yml new file mode 100644 index 0000000..25c6f36 --- /dev/null +++ b/content/tocs_guppy/architecture/toc_dev_en.yml @@ -0,0 +1,106 @@ +####################################################################### +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes +# +# +############################ SYNTAX ################################### +# GLOBAL OPTIONS: +# name: TOC (page) title +# template: name of template to use for this page - use 'generated_index.html' if unknown +# children: array of TOC entries +# +# TOC Entry: +# name: TOC entry (level 1) +# children: +# - +# name: optional name for TOC entry (default: use URL FrontMatter info) +# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js: +# - +# name: ... +# url: ... +# ... +# +# EXAMPLE: +# ------------------------------- +# name: Developer Guides +# template: generated_index.html +# children: +# - +# name: Application Framework +# children: +# - url: reference/af-main/overview.html +# - url: reference/af-main/afm-system-daemon.html +# - url: reference/af-main/afm-user-daemon.html +# ------------------------------- +####################################################################### + +name: Architecture Guides +template: generated_index.html +children: +- + name: AGL Specifications + children: + - + name: Automotive Grade Linux Requirements Specifications + url: reference/AGL_Specifications/agl_spec_v1.0_final.pdf +- + name: Security Blueprint + children: + - url: reference/security/README.html + - name: Part-1 Hardware + children: + - url: reference/security/part-1/0_Abstract.html + - name: Part-2 Secure Boot + children: + - url: reference/security/part-2/0_Abstract.html + - url: reference/security/part-2/1-Image.html + - url: reference/security/part-2/2-Communication-modes.html + - url: reference/security/part-2/3-Consoles.html + - name: Part-3 Hypervisor + children: + - url: reference/security/part-3/0_Abstract.html + - name: Part-4 Kernel + children: + - url: reference/security/part-4/0_Abstract.html + - url: reference/security/part-4/1-General.html + - url: reference/security/part-4/2-Memory.html + - url: reference/security/part-4/3-Consoles.html + - url: reference/security/part-4/4-Debug.html + - url: reference/security/part-4/5-FileSystems.html + - name: Part-5 Platform + children: + - url: reference/security/part-5/0_Abstract.html + - url: reference/security/part-5/1-MAC.html + - url: reference/security/part-5/2-SystemD.html + - url: reference/security/part-5/3-SystemBus.html + - url: reference/security/part-5/4-Services.html + - url: reference/security/part-5/5-AppFw.html + - url: reference/security/part-5/6-Utilities.html + - url: reference/security/part-5/7-Users.html + - name: Part-6 Application + children: + - url: reference/security/part-6/0_Abstract.html + - url: reference/security/part-6/1-Installation.html + - url: reference/security/part-6/2-PrivilegeManagement.html + - url: reference/security/part-6/3-Signature.html + - url: reference/security/part-6/4-Services.html + - name: Part-7 Connectivity + children: + - url: reference/security/part-7/0_Abstract.html + - url: reference/security/part-7/1-BusAndConnectors.html + - url: reference/security/part-7/2-Wireless.html + - url: reference/security/part-7/3-Cloud.html + - name: Part-8 Update + children: + - url: reference/security/part-8/0_Abstract.html + - url: reference/security/part-8/1-FOTA.html + - url: reference/security/part-8/2-SOTA.html + - name: Part-9 Secure development + children: + - url: reference/security/part-9/0_Abstract.html + - name: Annexes + children: + - url: reference/security/annexes/0_Abstract.html + - url: reference/security/annexes/ConfigNotes.html + - url: reference/security/annexes/todoNotes.html diff --git a/content/tocs_guppy/devguides/toc_dev_en.yml b/content/tocs_guppy/devguides/toc_dev_en.yml new file mode 100644 index 0000000..3c99142 --- /dev/null +++ b/content/tocs_guppy/devguides/toc_dev_en.yml @@ -0,0 +1,270 @@ +####################################################################### +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes +# +# +############################ SYNTAX ################################### +# GLOBAL OPTIONS: +# name: TOC (page) title +# template: name of template to use for this page - use 'generated_index.html' if unknown +# children: array of TOC entries +# +# TOC Entry: +# name: TOC entry (level 1) +# children: +# - +# name: optional name for TOC entry (default: use URL FrontMatter info) +# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js: +# - +# name: ... +# url: ... +# ... +# +# EXAMPLE: +# ------------------------------- +# name: Developer Guides +# template: generated_index.html +# children: +# - +# name: Application Framework +# children: +# - url: reference/af-main/overview.html +# - url: reference/af-main/afm-system-daemon.html +# - url: reference/af-main/afm-user-daemon.html +# ------------------------------- +####################################################################### + +name: Developer Guides +template: generated_index.html +children: +- + name: Yocto layers + children: + - url: reference/AGL.html + - url: reference/meta-agl.html + - url: reference/meta-agl-demo.html + - url: reference/meta-agl-devel.html +- + name: Host Configuration + children: + - + name: Abstract + url: reference/host-configuration/docs/0_Abstract.html + - + name: Prerequisites + url: reference/host-configuration/docs/1_Prerequisites.html + - + name: AGL Application Framework + url: reference/host-configuration/docs/2_AGL_Application_Framework.html + - + name: Binding Build Example + url: reference/host-configuration/docs/3_Binding_Build_Example.html + - + name: AGL XDS + url: reference/host-configuration/docs/4_AGL_XDS.html + - + name: CanDevStudio + url: reference/host-configuration/docs/5_Candevstudio.html +- + name: "Usage of CMake Afb Template module" + children: + - + name: "Abstract" + url: "reference/cmakeafbtemplates/0_Abstract.html" + - + name: "Quickstart" + url: "reference/cmakeafbtemplates/1_Quickstart.html" + - + name: "Project architecture" + url: "reference/cmakeafbtemplates/2_project_architecture.html" + - + name: "Advanced usage" + url: "reference/cmakeafbtemplates/3_advanced_usage.html" + - + name: "Advanced customization" + url: "reference/cmakeafbtemplates/4_advanced_customization.html" + - + name: "The autobuild script" + url: "reference/cmakeafbtemplates/5_autobuild.html" +- + name: "X(cross) Development System: User's Guide" + children: + - + name: Getting Started + url: reference/xds/part-1/0_Abstract.html + - + name: Installing xds-server + children: + - + name: Installation + url: reference/xds/part-1/1_install-xds-server.html + - + name: Based on Docker container + url: reference/xds/part-1/1-1_install-xds-server-docker.html + - + name: Based on Virtual Machine appliance + url: reference/xds/part-1/1-2_install-xds-server-vm.html + - + name: Native installation + url: reference/xds/part-1/1-3_install-xds-server-native.html + - + name: Installing xds client tools + url: reference/xds/part-1/2_install-client.html + - + name: Installing AGL SDKs + url: reference/xds/part-1/3_install-sdks.html + - + name: Create your first AGL application + children: + - + name: Prerequisites + url: reference/xds/part-1/4_build-first-app.html + - + name: Setup + url: reference/xds/part-1/4-1_build-first-app-setup.html + - + name: Build using command line tool + url: reference/xds/part-1/4-2_build-first-app-cmd.html + - + name: Build using XDS Dashboard + url: reference/xds/part-1/4-3_build-first-app-dashboard.html + - + name: Build using a source code editor / IDE + url: reference/xds/part-1/4-4_build-first-app-ide.html + - + name: Debug your first AGL application + children: + - + name: Prerequisites + url: reference/xds/part-1/5_debug-first-app.html + - + name: Configuration + url: reference/xds/part-1/5-1_debug-first-app-config.html + - + name: xds-gdb from command line + url: reference/xds/part-1/5-2_debug-first-app-cmd.html + - + name: xds-gdb within an IDE + url: reference/xds/part-1/5-3_debug-first-app-ide.html + +- + name: "X(cross) Development System: Internals" + children: + - + name: Abstract + url: reference/xds/part-2/0_Abstract.html + - + name: Prerequisites + url: reference/xds/part-2/1_Prerequisites.html + - + name: XDS-server + children: + - + name: Abstract + url: reference/xds/part-2/1_xds-server/0_abstract.html + - + name: Build from scratch + url: reference/xds/part-2/1_xds-server/1_build.html + - + name: Configuration + url: reference/xds/part-2/1_xds-server/2_config.html + - + name: How to run + url: reference/xds/part-2/1_xds-server/3_how-to-run.html + - + name: Debugging + url: reference/xds/part-2/1_xds-server/4_debug.html + - + name: Test + url: reference/xds/part-2/1_xds-server/5_test.html + - + name: XDS-agent + children: + - + name: Abstract + url: reference/xds/part-2/2_xds-agent/0_abstract.html + - + name: Build from scratch + url: reference/xds/part-2/2_xds-agent/1_build.html + - + name: Configuration + url: reference/xds/part-2/2_xds-agent/2_config.html + - + name: Start + url: reference/xds/part-2/2_xds-agent/3_start.html + - + name: Debugging + url: reference/xds/part-2/2_xds-agent/4_debug.html + - + name: XDS-cli + children: + - + name: Abstract + url: reference/xds/part-2/3_xds-cli/0_abstract.html + - + name: Build from scratch + url: reference/xds/part-2/3_xds-cli/1_build.html + - + name: Configuration + url: reference/xds/part-2/3_xds-cli/2_config.html + - + name: CLI Commands + url: reference/xds/part-2/3_xds-cli/3_commands.html + - + name: Debugging + url: reference/xds/part-2/3_xds-cli/4_debug.html + - + name: XDS-gdb + children: + - + name: Abstract + url: reference/xds/part-2/4_xds-gdb/0_abstract.html + - + name: Build from scratch + url: reference/xds/part-2/4_xds-gdb/1_build.html + - + name: Configuration + url: reference/xds/part-2/4_xds-gdb/2_config.html + - + name: Debugging + url: reference/xds/part-2/4_xds-gdb/3_debug.html +- + name: Guides + children: + - + name: AppFW - Privileges Management + url: reference/iotbzh2016/appfw/03-AGL-AppFW-Privileges-Management.pdf + +- + name: Controller Guide + children: + - url: reference/ctrler/controller.html + - url: reference/ctrler/controllerConfig.html + - url: reference/ctrler/Usage.html + - url: reference/ctrler/configSample.html + +- + name: AFB Helper functions reference + children: + - url: reference/afb-helpers/usage.html + - url: reference/afb-helpers/afb-timer.html + - url: reference/afb-helpers/curl-wrap.html + - url: reference/afb-helpers/escape.html + - url: reference/afb-helpers/filescan-utils.html + - url: reference/afb-helpers/qafbwebsocketclient.html + - url: reference/afb-helpers/json.html + - url: reference/afb-helpers/wrap-json.html + +- + name: "Continuous Integration - Automated Testing (CIAT)" + children: + - + name: Training + children: + - + name: "How to write tests (overview slides)" + url: reference/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf + - + name: "How to write tests (detailed)" + url: reference/CIAT/training/Hands_on_lab_documentation.pdf diff --git a/content/tocs_guppy/getting_started/toc_dev_en.yml b/content/tocs_guppy/getting_started/toc_dev_en.yml new file mode 100644 index 0000000..a534c61 --- /dev/null +++ b/content/tocs_guppy/getting_started/toc_dev_en.yml @@ -0,0 +1,64 @@ +####################################################################### +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes +# +# +############################ SYNTAX ################################### +# GLOBAL OPTIONS: +# name: TOC (page) title +# template: name of template to use for this page - use 'generated_index.html' if unknown +# children: array of TOC entries +# +# TOC Entry: +# name: TOC entry (level 1) +# children: +# - +# name: optional name for TOC entry (default: use URL FrontMatter info) +# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js: +# - +# name: ... +# url: ... +# ... +# +# EXAMPLE: +# ------------------------------- +# name: Developer Guides +# template: generated_index.html +# children: +# - +# name: Application Framework +# children: +# - url: reference/af-main/overview.html +# - url: reference/af-main/afm-system-daemon.html +# - url: reference/af-main/afm-user-daemon.html +# ------------------------------- +####################################################################### + +name: Getting started +template: generated_index.html +children: +- + name: Getting Started + children: + - url: reference/source-code.html + - url: reference/customize_bitbake_conf.html + - url: reference/machines/intel.html + - url: reference/machines/qemu.html + - url: reference/machines/R-Car-Starter-Kit-gen3.html + - url: reference/machines/raspberrypi.html +- + name: HomeScreen + children: + - url: reference/homescreen/index.html +- + name: Troubleshooting + children: + - url: reference/troubleshooting.html + - url: reference/footers/intel-footer.html + - url: reference/footers/raspberrypi-footer.html +- + name: SDK + children: + - url: reference/setup-sdk-environment.html + diff --git a/content/tocs_guppy/hardware/toc_dev_en.yml b/content/tocs_guppy/hardware/toc_dev_en.yml new file mode 100644 index 0000000..6c49ed8 --- /dev/null +++ b/content/tocs_guppy/hardware/toc_dev_en.yml @@ -0,0 +1,45 @@ +####################################################################### +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes +# +# +############################ SYNTAX ################################### +# GLOBAL OPTIONS: +# name: TOC (page) title +# template: name of template to use for this page - use 'generated_index.html' if unknown +# children: array of TOC entries +# +# TOC Entry: +# name: TOC entry (level 1) +# children: +# - +# name: optional name for TOC entry (default: use URL FrontMatter info) +# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js: +# - +# name: ... +# url: ... +# ... +# +# EXAMPLE: +# ------------------------------- +# name: Developer Guides +# template: generated_index.html +# children: +# - +# name: Application Framework +# children: +# - url: reference/af-main/overview.html +# - url: reference/af-main/afm-system-daemon.html +# - url: reference/af-main/afm-user-daemon.html +# ------------------------------- +####################################################################### + +name: Hardware Support +template: generated_index.html +children: +- + name: Renesas Gen3 Boards + children: + - url: reference/renesas-gen3/gen3.html + - url: reference/renesas-gen3/proprietary.html |