scotty-config.yaml

All the information scotty uses is defined in scotty-config.yaml found in the manifest(s). There can be multiple manifests configured (see --extra-download option at Scotty commands)

file structure

base

The base section contains all items that will be always automatically included

option	type	notes
description	str	Human readable description
snippets	list	Paths of kas configuration snippets from the same repository as the scotty-config.yaml file

example

base:
  - description: "Mandatory items"
    snippets:
      - "snippets/base/base.yml"

distro

The distro section contains configuration of selectable DISTRO entries

option	type	notes
description	str	Human readable description
name	str	Unique id of the feature
requires_feature	list	List of feature ids this feature requires
snippets	list	Paths of kas configuration snippets from the same repository as the scotty-config.yaml file

example

distros:
  - name: "poky"
    description: "Poky distribution"
    snippets:
      - "snippets/distro/poky.yml"
  - name: "simplecore"
    description: "SimpleCore distribution"
    snippets:
      - "snippets/distro/simplecore.yml"
    requires_feature:
      - openembedded

machine

The machine section contains configuration of selectable MACHINE entries

option	type	notes
description	str	Human readable description
licenses	optional/list	List of license
name	str	Unique id of the feature
overlays	dict	Key/value table of configurable overlays. Key=filename, value=human readable description
snippets	list	Paths of kas configuration snippets from the same repository as the scotty-config.yaml file

example

machine:
  - name: "sm2s-imx8plus"
    description: "sm2s-imx8plus"
    snippets:
      - "snippets/machine/sm2s-imx8plus.yml"
    licenses:
      - url: "https://raw.githubusercontent.com/Freescale/meta-freescale/scarthgap/EULA"
        env: "ACCEPT_FSL_EULA"
        description: "NXP layers are used: NXP End User License Agreement need to be accepted."
    overlays:
      overlay-baseboard-ep1.dtb: "EP1 carrier board"
      overlay-hdmi.dtb: "HDMI display"
  - name: "sm2s-imx8mini"
    description: "sm2s-imx8mini"
    snippets:
      - "snippets/machine/sm2s-imx8mini.yml"
    licenses:
      - url: "https://raw.githubusercontent.com/Freescale/meta-freescale/scarthgap/EULA"
        env: "ACCEPT_FSL_EULA"
        description: "NXP layers are used: NXP End User License Agreement need to be accepted."
    overlays:
      overlay-lvds-ama-101a01.dtb: "AMA101(A01) display"
      overlay-extra-smarc-pins.dtb: "Extra SMARC pins"

license

option	type	notes
description	str	Human readable description
env	str	Name of the environment variable that automatically sets the approval
url	str/url	Publicly accessible URL where the license text can be downloaded from

feature

The section feature contains one or more feature defintions, each with the following options

option	type	notes
conflicts	optional/list	List of feature name(s) that can’t be used in combination with this feature
description	str	Human readable description
extends_machine	optional/list	List of machine sections to extend the original
limit_distro	optional/list	List of distro ids the feature is only compatible with
limit_machine	optional/list	List of machines the feature is only compatible with
name	str	Unique id of the feature
requires_feature	list	List of feature ids this feature requires
snippets	list	Paths of kas configuration snippets from the same repository as the scotty-config.yaml file

example

features:
  - name: virtualization
    description: "Virtualization support"
    snippets:
      - "snippets/feature/meta-virtualization.yml"
    limit_distros:
      - simplecore
  - name: myfeature
    description: "My feature"
    snippets:
      - "snippets/feature/meta-myfeature.yml"
    requires_feature:
      - clang
  - name: clang
    description: "Clang support"
    snippets:
      - "snippets/feature/meta-clang.yml"
  - name: mymachine-feature
    description: "My machine extensions"
    snippets:
      - "snippets/feature/meta-mymachine.yml"
    extends_machine:
      - name: "sm2s-imx8plus"
        overlays:
          overlay-my-display.dtb: "My project specific display overlay"