aboutsummaryrefslogtreecommitdiffstats
path: root/content/tocs/devguides/fetched_files.yml
blob: 1df36b196814bc526a1d094d2a4635188590e3e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
##############################################################################################################
# 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: AGL 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: src/libappcontroller
    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
-
    git_name: src/libafb-helpers
    src_prefix: docs
    dst_prefix: afb-helpers
    documents:
        - source: usage.md
          label: Usage
        - source: afb-timer.md
          label: AFB Timer
        - source: curl-wrap.md
          label: CURL wrapper
        - source: escape.md
          label: URL escaping
        - source: filescan-utils.md
          label: Filescan Utils
        - source: qafbwebsocketclient.md
          label: Qt AFB Websocket client
        - source: json.md
          label: JSON library for modern C++
        - source: wrap-json.md
          label: C JSON Wrapper