summaryrefslogtreecommitdiff
path: root/upstream-layers/bitbake/setup-schema/bitbake-setup.schema.json
blob: bb10a9255d7d2e99146a4f498f76ad3c3c4bb8c3 (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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "description": "Schema for bitbake-setup configuration files",
    "examples" : [
        {
            "description": "Example bitbake-setup configuration file",
            "sources": {
                "bitbake": {
                    "git-remote": {
                        "uri": "https://git.openembedded.org/bitbake",
                        "rev": "master"
                    },
                    "path": "bitbake"
                },
                "openembedded-core": {
                    "git-remote": {
                        "uri": "https://git.openembedded.org/openembedded-core",
                        "rev": "master"
                    },
                    "path": "openembedded-core"
                }
            },
            "bitbake-setup": {
                "configurations": [
                    {
                        "name" : "qemux86-64-nodistro",
                        "description": "OpenEmbedded 'nodistro' build for qemux86-64",
                        "setup-dir-name": "oe-nodistro-master",
                        "bb-layers": ["openembedded-core/meta"],
                        "oe-fragments": ["machine/qemux86-64"]
                    }
                ]
            },
            "version": "1.0"
        }
    ],
    "title": "bitbake-setup configuration file",
    "type": "object",
    "required": [
        "description",
        "bitbake-setup",
        "version"
    ],
    "properties": {
        "description": {
            "type": "string",
            "description": "Description of the bitbake-setup configuration file"
        },
        "sources": {
            "$ref": "layers.schema.json#/properties/sources"
        },
        "expires": {
            "type": "string",
            "description": "End of life date for this configuration, in ISO 8601 format (YYYY-MM-DD)"
        },
        "bitbake-setup": {
            "type": "object",
            "description": "BitBake-setup configurations",
            "required": [
                "configurations"
            ],
            "properties": {
                "configurations": {
                    "type": "array",
                    "minItems": 1,
                    "$anchor": "configurations",
                    "items": {
                        "type": "object",
                        "properties": {
                            "name": {
                                "type": "string",
                                "description": "Name of the configuration"
                            },
                            "description": {
                                "type": "string",
                                "description": "Human-readable description of the configuration"
                            },
                            "notes": {
                                "anyOf": [
                                    {
                                        "type": "string"
                                    },
                                    {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    }
                                ],
                                "description": "Extra notes that populate conf-notes.txt when bb-layers is used"
                            },
                            "bb-layers": {
                                "type": "array",
                                "description": "List of BitBake layer paths to include, relative to the layers download directory",
                                "items": {
                                    "type": "string"
                                }
                            },
                            "bb-layers-file-relative": {
                                "type": "array",
                                "description": "List of BitBake layers paths to include, relative to the directory with the configuration file",
                                "items": {
                                    "type": "string"
                                }
                            },
                            "oe-template": {
                                "type": "string",
                                "description": "OE-template configuration"
                            },
                            "oe-fragments": {
                                "$anchor": "oe-fragments",
                                "type": "array",
                                "description": "List of BitBake configuration fragments to enable",
                                "items": {
                                    "anyOf": [
                                        {
                                            "type": "string",
                                            "description": "Configuration fragment name"
                                        },
                                        {
                                            "type": "object",
                                            "description": "Dictionary of BitBake configuration fragments to enable (with description)",
                                            "properties": {
                                                "name": {
                                                    "type": "string",
                                                    "description": "Configuration fragment name"
                                                },
                                                "description": {
                                                    "type": "string",
                                                    "description": "Human-readable description of the fragment"
                                                }
                                            }
                                        }
                                    ]
                                }
                            },
                            "oe-fragments-one-of": {
                                "type": "object",
                                "description": "Mutually exclusive bitbake configuration fragment",
                                "patternProperties": {
                                    ".*": {
                                        "type": "object",
                                        "required": [
                                            "description",
                                            "options"
                                        ],
                                        "properties": {
                                            "description": {
                                                "type": "string",
                                                "description": "Human-readable description of the fragment category"
                                            },
                                            "options": {
                                                "$ref": "#oe-fragments"
                                            }
                                        },
                                        "additionalProperties": false
                                    }
                                },
                                "additionalProperties": false
                            },
                            "configurations": {
                                "$ref": "#configurations"
                            },
                            "bb-env-passthrough-additions": {
                                "type": "array",
                                "description": "List of environment variables to include in BB_ENV_PASSTHROUGH_ADDITIONS",
                                "items": {
                                    "type": "string"
                                }
                            },
                            "setup-dir-name": {
                                "type": "string",
                                "description": "A suggestion for the setup directory name, $-prefixed keys from oe-fragments-one-of will be substituted with user selections."
                            },
                            "install-buildtools": {
                                "type": "object",
                                "description": "Settings for downloading buildtools via bb.fetch",
                                "properties": {
                                    "url": {
                                        "type": "string",
                                        "minLength": 1,
                                        "description": "Full URL to the buildtools SDK installer."
                                    },
                                    "sha256sum": {
                                        "type": "string",
                                        "minLength": 1,
                                        "description": "SHA256 checksum of the buildtools installer."
                                    }
                                },
                                "required": [
                                    "url",
                                    "sha256sum"
                                ],
                                "additionalProperties": false
                            }
                        },
                        "additionalProperties": false
                    }
                }
            },
            "additionalProperties": false
        },
        "version": {
            "description": "The version of this document; currently '1.0'",
            "enum": [
                "1.0"
            ]
        }
    },
    "additionalProperties": false
}