[rtems-central commit] qdp: Build RTEMS documentation

Sebastian Huber sebh at rtems.org
Tue Nov 21 13:35:41 UTC 2023


Module:    rtems-central
Branch:    master
Commit:    e280a973608067c1f45a663f2358747a7e294b6a
Changeset: http://git.rtems.org/rtems-central/commit/?id=e280a973608067c1f45a663f2358747a7e294b6a

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Nov 21 11:13:17 2023 +0100

qdp: Build RTEMS documentation

---

 requirements.txt                      |  1 +
 spec-qdp/qdp/deployment/doc-rtems.yml | 17 +++++++++
 spec-qdp/qdp/package-build.yml        |  2 +
 spec-qdp/qdp/steps/doc-rtems.yml      | 70 +++++++++++++++++++++++++++++++++++
 4 files changed, 90 insertions(+)

diff --git a/requirements.txt b/requirements.txt
index c7cd3c16..41c8e253 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -10,6 +10,7 @@ coverage>=6.2
 cPyparsing>=2.4.7.1.2.0
 dataclasses>=0.8;python_version<"3.7"
 dill>=0.3.4
+distro>=1.8.0
 docutils>=0.17.1
 entrypoints>=0.4
 flake8>=5.0.4
diff --git a/spec-qdp/qdp/deployment/doc-rtems.yml b/spec-qdp/qdp/deployment/doc-rtems.yml
new file mode 100644
index 00000000..9a6430df
--- /dev/null
+++ b/spec-qdp/qdp/deployment/doc-rtems.yml
@@ -0,0 +1,17 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2023 embedded brains GmbH & Co. KG
+copyrights-by-license: {}
+directory: ${../variant:/deployment-directory}/doc/rtems
+directory-state-type: generic
+enabled-by: true
+files: []
+hash: null
+links:
+- hash: null
+  name: member
+  role: input-to
+  uid: ../steps/archive
+patterns: []
+qdp-type: directory-state
+type: qdp
diff --git a/spec-qdp/qdp/package-build.yml b/spec-qdp/qdp/package-build.yml
index 20148544..6b291c5c 100644
--- a/spec-qdp/qdp/package-build.yml
+++ b/spec-qdp/qdp/package-build.yml
@@ -29,6 +29,8 @@ links:
   uid: steps/doxygen-tagfile
 - role: build-step
   uid: steps/doc-ddf-sdd
+- role: build-step
+  uid: steps/doc-rtems
 - role: build-step
   uid: steps/archive
 qdp-type: package-build
diff --git a/spec-qdp/qdp/steps/doc-rtems.yml b/spec-qdp/qdp/steps/doc-rtems.yml
new file mode 100644
index 00000000..f584a230
--- /dev/null
+++ b/spec-qdp/qdp/steps/doc-rtems.yml
@@ -0,0 +1,70 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+build-step-type: run-actions
+actions:
+- action: remove-glob
+  enabled-by: true
+  remove-tree: true
+  path: ${.:/params/working-directory}
+  patterns:
+  - build
+  - .lock-waf*
+  - .waf*
+- action: subprocess
+  command:
+  - ./waf
+  - configure
+  - --prefix=${../deployment/doc-rtems:/directory}
+  - --pdf
+  enabled-by: true
+  env: []
+  expected-return-code: 0
+  working-directory: ${.:/params/working-directory}
+- action: subprocess
+  command:
+  - ./waf
+  - build
+  enabled-by: true
+  env: []
+  expected-return-code: 0
+  working-directory: ${.:/params/working-directory}
+- action: subprocess
+  command:
+  - ./waf
+  - install
+  - --destdir=${.:/params/intermediate-directory}
+  enabled-by: true
+  env: []
+  expected-return-code: 0
+  working-directory: ${.:/params/working-directory}
+- action: directory-state-move-tree
+  enabled-by: true
+  excludes: []
+  output-name: deployment
+  prefix: null
+  root: ${.:/params/intermediate-directory}
+- action: remove-glob
+  enabled-by: true
+  remove-tree: true
+  path: ${.:/params/working-directory}
+  patterns:
+  - build
+  - .lock-waf*
+  - .waf*
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+description: |
+  Builds the RTEMS documentation.
+enabled-by: true
+links:
+- hash: null
+  name: source
+  role: input
+  uid: ../source/rtems-docs
+- name: deployment
+  role: output
+  uid: ../deployment/doc-rtems
+params:
+  intermediate-directory: ${.:/params/working-directory}/destdir
+  working-directory: ${../source/rtems-docs:/directory}
+qdp-type: build-step
+type: qdp



More information about the vc mailing list