SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH & Co. KG
enabled-by: true
links:
- role: spec-member
  uid: root
- role: spec-refinement
  spec-key: build-type
  spec-value: script
  uid: build
spec-description: null
spec-example: |
  SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
  build-type: script
  copyrights:
  - Copyright (C) 2020 embedded brains GmbH & Co. KG
  default: null
  default-by-variant: []
  do-build: |
    bld.install_as(
        "${BSP_LIBDIR}/linkcmds",
        "bsps/" + bld.env.ARCH + "/" + bld.env.BSP_FAMILY +
        "/start/linkcmds." + bld.env.BSP_BASE
    )
  do-configure: |
    conf.env.append_value(
        "LINKFLAGS",
        ["-qnolinkcmds", "-T", "linkcmds." + conf.env.BSP_BASE]
    )
  enabled-by: true
  links: []
  prepare-build: null
  prepare-configure: null
  type: build
spec-info:
  dict:
    attributes:
      asflags:
        description: null
        spec-type: build-asflags
      cflags:
        description: null
        spec-type: build-cflags
      cppflags:
        description: null
        spec-type: build-cppflags
      cxxflags:
        description: null
        spec-type: build-cxxflags
      do-build:
        description: |
          If this script shall execute, then it shall be Python code which is
          executed via ``exec()`` in the context of the ``do_build()`` method
          of the :file:`wscript`.  A local variable ``bld`` is available with
          the ``waf`` build context.  A local variable ``bic`` is available
          with the build item context.
        spec-type: optional-str
      do-configure:
        description: |
          If this script shall execute, then it shall be Python code which is
          executed via ``exec()`` in the context of the ``do_configure()``
          method of the :file:`wscript`.  A local variable ``conf`` is
          available with the ``waf`` configuration context.  A local variable
          ``cic`` is available with the configuration item context.
        spec-type: optional-str
      includes:
        description: null
        spec-type: build-includes
      ldflags:
        description: null
        spec-type: build-ldflags
      prepare-build:
        description: |
          If this script shall execute, then it shall be Python code which is
          executed via ``exec()`` in the context of the ``prepare_build()``
          method of the :file:`wscript`.  A local variable ``bld`` is available
          with the ``waf`` build context.  A local variable ``bic`` is
          available with the build item context.
        spec-type: optional-str
      prepare-configure:
        description: |
          If this script shall execute, then it shall be Python code which is
          executed via ``exec()`` in the context of the ``prepare_configure()``
          method of the :file:`wscript`.  A local variable ``conf`` is
          available with the ``waf`` configuration context.  A local variable
          ``cic`` is available with the configuration item context.
        spec-type: optional-str
      stlib:
        description: null
        spec-type: build-stlib-list
      target:
        description: null
        spec-type: build-target
      use-after:
        description: null
        spec-type: build-use-after-list
      use-before:
        description: null
        spec-type: build-use-before-list
    description: |
      This set of attributes specifies a build script.  The optional attributes
      may be required by commands executed through the scripts.
    mandatory-attributes:
    - do-build
    - do-configure
    - prepare-build
    - prepare-configure
spec-name: Build Script Item Type
spec-type: build-script
type: spec