aboutsummaryrefslogtreecommitdiffstats
path: root/content/tocs
diff options
context:
space:
mode:
authorStéphane Desneux <stephane.desneux@iot.bzh>2018-12-06 19:51:01 +0100
committerStéphane Desneux <stephane.desneux@iot.bzh>2018-12-06 19:51:01 +0100
commit85d015213b015ec82d102ccfcbae0c6c4669978e (patch)
treefaabe6f2a7a6878e51b3aae210a984d5b9ea49fb /content/tocs
parent3b378aa49fbe91da3f144ad74087bd4771068729 (diff)
tocs: forward port from master branch
This commit ports the adjustments recently made on master branch to the master-next branch, while keeping changes related to doc reorganization. Change-Id: I3d222bba1151bf0dd9136bed95a88bb2de9bdc24 Signed-off-by: Stéphane Desneux <stephane.desneux@iot.bzh>
Diffstat (limited to 'content/tocs')
-rw-r--r--content/tocs/apis_services/fetched_files.yml100
-rw-r--r--content/tocs/apis_services/toc_dev_en.yml39
-rw-r--r--content/tocs/architecture/fetched_files.yml22
-rw-r--r--content/tocs/devguides/fetched_files.yml30
-rw-r--r--content/tocs/getting_started/fetched_files.yml28
-rw-r--r--content/tocs/getting_started/section_master.yml2
-rw-r--r--content/tocs/hardware/fetched_files.yml11
7 files changed, 113 insertions, 119 deletions
diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml
index a279a5e..f1709a0 100644
--- a/content/tocs/apis_services/fetched_files.yml
+++ b/content/tocs/apis_services/fetched_files.yml
@@ -5,8 +5,8 @@
#
# 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)
+# 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%
@@ -37,14 +37,13 @@
# ------------------------------------
##############################################################################################################
-url_fetch : "GERRIT_FETCH"
-git_commit : "AGL_GERRIT_BRANCH"
+url_fetch: GERRIT_FETCH
+git_commit: AGL_GERRIT_BRANCH
repositories:
-
- git_name : src/app-framework-main
- git_commit: master
- src_prefix : docs
+ git_name: src/app-framework-main
+ src_prefix: docs
dst_prefix: af-main
documents:
- source: 0-introduction.md
@@ -70,9 +69,8 @@ repositories:
- source: pictures/triskel_iot_bzh.svg
-
- git_name : src/app-framework-binder
- git_commit: master
- src_prefix : docs
+ git_name: src/app-framework-binder
+ src_prefix: docs
dst_prefix: af-binder
documents:
- source: index.md
@@ -129,9 +127,8 @@ repositories:
- source: pictures/triskel_iot_bzh.svg
-
- git_name : apps/agl-service-can-low-level
- git_commit: master
- src_prefix : docs
+ git_name: apps/agl-service-can-low-level
+ src_prefix: docs
dst_prefix: signaling
documents:
- source: 1-Architecture.md
@@ -148,9 +145,8 @@ repositories:
- source: images/OpenXC_to_AGL.png
-
- git_name : apps/app-afb-test
- git_commit: master
- src_prefix : docs
+ git_name: apps/app-afb-test
+ src_prefix: docs
dst_prefix: afb-test
documents:
- source: 0_Installation.md
@@ -201,9 +197,10 @@ repositories:
-
url_fetch: GITHUB_FETCH
- git_name : iotbzh/high-level-viwi-service
+ url_edit: GITHUB_EDIT
+ git_name: iotbzh/high-level-viwi-service
git_commit: master
- src_prefix : docs
+ src_prefix: docs
dst_prefix: signaling
documents:
- source: 1-Architecture.md
@@ -214,9 +211,7 @@ repositories:
label: Installation and Usage Guide
- source: images/high-level-arch.png
-
- url_fetch: "GERRIT_FETCH"
git_name: apps/agl-service-signal-composer
- git_commit: "master"
src_prefix: docs/part-1/
dst_prefix: signaling
documents:
@@ -235,9 +230,10 @@ repositories:
- source: pictures/Global_Signaling_Architecture.png
- source: pictures/iotbzh_logo_small.png
-
- url_fetch: "GITHUB_FETCH"
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
git_name: iotbzh/agl-documentation
- git_commit: "master"
+ git_commit: master
documents:
- source: candevstudio/docs/1_Usage.md
- source: candevstudio/docs/2_can_device_socketcan_backend.md
@@ -250,8 +246,9 @@ repositories:
-
url_fetch: AGL_GITHUB_FETCH
- git_name: "automotive-grade-linux/docs-sources"
- git_commit: master-next
+ 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:
@@ -260,8 +257,9 @@ repositories:
label: Resources
-
url_fetch: AGL_GITHUB_FETCH
- git_name: "automotive-grade-linux/docs-sources"
- git_commit: master-next
+ 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:
@@ -287,8 +285,8 @@ repositories:
-
url_fetch: AGL_GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
- git_name: "automotive-grade-linux/docs-sources"
- git_commit: master-next
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: AGL_GITHUB_BRANCH
src_prefix: docs/audio
dst_prefix: audio
documents:
@@ -299,10 +297,8 @@ repositories:
destination: bluez-alsa.md
label: bluez-alsa
-
- url_fetch: "GERRIT_FETCH"
- git_commit : "AGL_GERRIT_BRANCH"
git_name: apps/agl-service-audio-4a
- src_prefix : docs
+ src_prefix: docs
dst_prefix: audio
documents:
- source: 4a-framework/README.md
@@ -331,46 +327,46 @@ repositories:
- source: high-level-api/TipsAndTricks/images/changeSound.png
- source: high-level-api/TipsAndTricks/images/MixerBaseMenu.png
-
- url_fetch: "GERRIT_FETCH"
+ 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
- git_commit: "master"
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/showInformation.svg
- - source: parts/showNotification.svg
- source: parts/showOnScreen.svg
- - source: parts/showWindow.svg
- - source: parts/software-stack.png
- - source: parts/tap_shortcut.svg
-
+ - source: parts/showNotification.svg
+ - source: parts/showInformation.svg
-
- url_fetch: "GERRIT_FETCH"
git_name: apps/agl-service-windowmanager
- git_commit: "master"
src_prefix: doc/
dst_prefix: hmi-framework/
documents:
- source: ApplicationGuide.md
destination: 3_2-WindowManager-Guide.md
label: Window Manager Developper Guide
- - source: parts/deactivate_window.png
- - source: parts/wm_software_stack.png
- - source: parts/example_split.png
- source: parts/state_change_example.png
- - source: parts/hmi_framework_designed_seq_toyota.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/wm_layer_stack.png
+ - source: parts/hmi_framework_designed_seq_toyota.png
+ - source: parts/deactivate_window.png
+ - source: parts/example_split.png
-
- url_fetch: "GERRIT_FETCH"
git_name: apps/agl-service-soundmanager
- git_commit: "master"
src_prefix: doc/
dst_prefix: hmi-framework/
documents:
@@ -398,11 +394,9 @@ repositories:
- source: parts/typical-usecase.png
- source: parts/am-component.png
-
- url_fetch : GERRIT_FETCH
- git_commit : master
- git_name : apps/homescreen
- src_prefix : homescreen/docs
- dst_prefix : homescreen
+ git_name: apps/homescreen
+ src_prefix: homescreen/docs
+ dst_prefix: homescreen
documents:
- source: homescreen_api.md
label: HomeScreen API
diff --git a/content/tocs/apis_services/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml
index 1d16069..023e699 100644
--- a/content/tocs/apis_services/toc_dev_en.yml
+++ b/content/tocs/apis_services/toc_dev_en.yml
@@ -85,27 +85,24 @@ children:
name: AGL Test Framework
children:
- url: reference/afb-test/Installation.html
- - url: reference/afb-test/test-example.html
- - url: reference/afb-test/launch-the-example.html
- - name: Write Your Tests
+ - 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/project-tree.html
- - url: reference/afb-test/binding-configuration.html
- - url: reference/afb-test/Lua-test-files.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
+ - 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
@@ -147,6 +144,7 @@ children:
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
@@ -180,3 +178,4 @@ children:
children:
- url: reference/homescreen/homescreen_api.html
+
diff --git a/content/tocs/architecture/fetched_files.yml b/content/tocs/architecture/fetched_files.yml
index 5903a18..b57d5d2 100644
--- a/content/tocs/architecture/fetched_files.yml
+++ b/content/tocs/architecture/fetched_files.yml
@@ -5,8 +5,8 @@
#
# 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)
+# 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%
@@ -37,11 +37,11 @@
# ------------------------------------
##############################################################################################################
-url_fetch : "AGL_GITHUB_FETCH"
-url_edit : "AGL_GITHUB_EDIT"
-git_commit : "AGL_GITHUB_BRANCH"
-#git_commit : # default defined in _tocs/xxxx/latest.yml
-#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source)
+#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:
-
@@ -51,9 +51,11 @@ repositories:
- source: agl_spec_v1.0_final.pdf
-
- git_name : "automotive-grade-linux/docs-sources"
- git_commit: master-next
- src_prefix : docs/security-blueprint
+ 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
diff --git a/content/tocs/devguides/fetched_files.yml b/content/tocs/devguides/fetched_files.yml
index 6785d1b..2d9d6d3 100644
--- a/content/tocs/devguides/fetched_files.yml
+++ b/content/tocs/devguides/fetched_files.yml
@@ -5,8 +5,8 @@
#
# 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)
+# 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%
@@ -37,8 +37,9 @@
# ------------------------------------
##############################################################################################################
-url_fetch : "GERRIT_FETCH"
-git_commit: "AGL_GERRIT_BRANCH"
+url_fetch: GERRIT_FETCH
+git_commit: AGL_GERRIT_BRANCH
+
repositories:
-
git_name: AGL/meta-agl
@@ -67,9 +68,10 @@ repositories:
documents:
- source: appfw/03-AGL-AppFW-Privileges-Management.pdf
-
- url_fetch: "GITHUB_FETCH"
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
git_name: iotbzh/agl-documentation
- git_commit: "master"
+ git_commit: master
documents:
- source: host-configuration/docs/0_Abstract.md
- source: host-configuration/docs/1_Prerequisites.md
@@ -78,9 +80,10 @@ repositories:
- source: host-configuration/docs/4_AGL_XDS.md
- source: host-configuration/docs/5_Candevstudio.md
-
- url_fetch: "GITHUB_FETCH"
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
git_name: iotbzh/agl-documentation
- git_commit: "master"
+ git_commit: master
documents:
- source: sdk-devkit/docs/part-1/1_0_Abstract.md
- source: sdk-devkit/docs/part-1/1_1-Deploy_image.md
@@ -118,9 +121,7 @@ repositories:
- source: sdk-devkit/docs/part-2/pictures/web-runtime_app.png
- source: sdk-devkit/docs/part-2/pictures/xming_server.png
-
- url_fetch: "GERRIT_FETCH"
git_name: src/cmake-apps-module
- git_commit: "master"
src_prefix: "docs/dev_guide"
dst_prefix: "cmakeafbtemplates"
documents:
@@ -131,9 +132,7 @@ repositories:
- source: 4_advanced_customization.md
- source: 5_autobuild.md
-
- url_fetch: "GERRIT_FETCH"
git_name: src/xds/xds-docs
- git_commit: "master"
src_prefix: "docs"
dst_prefix: "xds"
documents:
@@ -195,16 +194,15 @@ repositories:
- source: part-2/4_xds-gdb/3_debug.md
-
- url_fetch: "GITHUB_FETCH"
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
git_name: baylibre/agl-docs-baylibre
- git_commit: "master"
+ git_commit: master
documents:
- source: CIAT/training/How_to_write_your_own_tests_for_AGL.pdf
- source: CIAT/training/Hands_on_lab_documentation.pdf
-
- url_fetch: "GERRIT_FETCH"
git_name: apps/app-controller-submodule
- git_commit: master
src_prefix: docs
dst_prefix: ctrler
documents:
diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml
index 53e4c71..4113447 100644
--- a/content/tocs/getting_started/fetched_files.yml
+++ b/content/tocs/getting_started/fetched_files.yml
@@ -5,8 +5,8 @@
#
# 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)
+# 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%
@@ -37,16 +37,18 @@
# ------------------------------------
##############################################################################################################
-url_fetch : "AGL_GITHUB_FETCH"
-url_edit : "AGL_GITHUB_EDIT"
-git_commit : "AGL_GITHUB_BRANCH"
-#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source)
+#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source)
+
+url_fetch: GERRIT_FETCH
+git_commit: AGL_GERRIT_BRANCH
repositories:
-
- git_name : "automotive-grade-linux/docs-sources"
- git_commit: master-next
- src_prefix : docs/getting-started
+ 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: app-workflow-intro.md
label: Overview
@@ -101,11 +103,9 @@ repositories:
- source: docker-container-setup.md
label: Setting Up a Docker Container
-
- url_fetch : GERRIT_FETCH
- git_name : apps/homescreen
- git_commit : AGL_GERRIT_BRANCH
- src_prefix : homescreen/docs
- dst_prefix : homescreen
+ git_name: apps/homescreen
+ src_prefix: homescreen/docs
+ dst_prefix: homescreen
documents:
- source: index.md
label: Overview
diff --git a/content/tocs/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml
index 35f39ea..b6e663c 100644
--- a/content/tocs/getting_started/section_master.yml
+++ b/content/tocs/getting_started/section_master.yml
@@ -8,7 +8,7 @@ books:
-
id: docs-source-getting-started
git_name: "automotive-grade-linux/docs-sources"
- git_commit: master-next
+ git_commit: AGL_GITHUB_BRANCH
path: docs/getting-started-book.yml
-
id: homescreen
diff --git a/content/tocs/hardware/fetched_files.yml b/content/tocs/hardware/fetched_files.yml
index 9e0a5ec..f1decf7 100644
--- a/content/tocs/hardware/fetched_files.yml
+++ b/content/tocs/hardware/fetched_files.yml
@@ -5,8 +5,8 @@
#
# 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)
+# 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%
@@ -37,9 +37,10 @@
# ------------------------------------
##############################################################################################################
-url_fetch : "GERRIT_FETCH"
-git_commit : "AGL_GERRIT_BRANCH"
-#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source)
+#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source)
+
+url_fetch: "GERRIT_FETCH"
+git_commit: "AGL_GERRIT_BRANCH"
repositories:
-