aboutsummaryrefslogtreecommitdiffstats
path: root/content/tocs/hardware/fetched_files.yml
diff options
context:
space:
mode:
Diffstat (limited to 'content/tocs/hardware/fetched_files.yml')
-rw-r--r--content/tocs/hardware/fetched_files.yml58
1 files changed, 58 insertions, 0 deletions
diff --git a/content/tocs/hardware/fetched_files.yml b/content/tocs/hardware/fetched_files.yml
new file mode 100644
index 0000000..62b1c0d
--- /dev/null
+++ b/content/tocs/hardware/fetched_files.yml
@@ -0,0 +1,58 @@
+##############################################################################################################
+# 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"
+#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source)
+
+repositories:
+-
+ git_name: AGL/meta-renesas
+ dst_prefix: renesas
+ documents:
+ - source: meta-rcar-gen2/README
+ destination: gen2.md
+ label: meta-rcar-gen2 layer
+ - source: meta-rcar-gen2/README.proprietary
+ destination: proprietary.md
+ label: Proprietary drivers
+ - source: meta-rcar-gen2/README-usbgadget.md
+ destination: usb-gadget.md
+ label: USB Gadget on Porter board
+