summaryrefslogtreecommitdiff
path: root/spec-qdp/spec/qdp-directory-state.yml
blob: 838eeaf7ea4d340941359987e5f4f21b5cccfac0 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020, 2023 embedded brains GmbH & Co. KG
enabled-by: true
links:
- role: spec-member
  uid: root
- role: spec-refinement
  spec-key: qdp-type
  spec-value: directory-state
  uid: qdp-root
spec-description: null
spec-example: null
spec-info:
  dict:
    attributes:
      copyrights-by-license:
        description: null
        spec-type: qdp-copyrights-by-license
      directory:
        description: |
          It shall be the path to the directory.  A variable substitution is
          performed on the value.  For example, you can use
          ``$${/variant:/build-directory}/some/path/in/build/directory`` or
          ``$${/variant:/deployment-directory}/some/path/in/deployment/directory``.
        spec-type: str
      directory-state-type:
        description: |
          It shall be the directory state type.
        spec-type: name
      patterns:
        description: null
        spec-type: qdp-directory-state-pattern-list
      files:
        description: null
        spec-type: qdp-file-state-list
      hash:
        description: |
          If the value is present, then it shall be the hash of the file state
          list and the directory path, otherwise the directory state is
          invalid.
        spec-type: qdp-optional-sha512
    description: |
      This set of attributes specifies a directory state.
    mandatory-attributes: all
spec-name: Directory State Item Type
spec-type: qdp-directory-state
type: spec