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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
#!/usr/bin/env python3
#
# Add version information to poky.yaml based upon current git branch/tags
# Also generate the list of available manuals (releases.rst file)
#
# Copyright Linux Foundation
# Author: Richard Purdie <richard.purdie@linuxfoundation.org>
# Author: Quentin Schulz <foss@0leil.net>
#
# SPDX-License-Identifier: MIT
#
import subprocess
import collections
import sys
import os
import itertools
import re
ourversion = None
if len(sys.argv) == 2:
ourversion = sys.argv[1]
ourversion = None
if len(sys.argv) == 2:
ourversion = sys.argv[1]
activereleases = ["kirkstone", "dunfell"]
devbranch = "langdale"
ltsseries = ["kirkstone", "dunfell"]
# used by run-docs-builds to get the default page
if ourversion == "getlatest":
print(activereleases[0])
sys.exit(0)
release_series = collections.OrderedDict()
release_series["langdale"] = "4.1"
release_series["kirkstone"] = "4.0"
release_series["honister"] = "3.4"
release_series["hardknott"] = "3.3"
release_series["gatesgarth"] = "3.2"
release_series["dunfell"] = "3.1"
release_series["zeus"] = "3.0"
release_series["warrior"] = "2.7"
release_series["thud"] = "2.6"
release_series["sumo"] = "2.5"
release_series["rocko"] = "2.4"
release_series["pyro"] = "2.3"
release_series["morty"] = "2.2"
release_series["krogoth"] = "2.1"
release_series["jethro"] = "2.0"
release_series["jethro-pre"] = "1.9"
release_series["fido"] = "1.8"
release_series["dizzy"] = "1.7"
release_series["daisy"] = "1.6"
release_series["dora"] = "1.5"
release_series["dylan"] = "1.4"
release_series["danny"] = "1.3"
release_series["denzil"] = "1.2"
release_series["edison"] = "1.1"
release_series["bernard"] = "1.0"
release_series["laverne"] = "0.9"
bitbake_mapping = {
"langdale" : "2.2",
"kirkstone" : "2.0",
"honister" : "1.52",
"hardknott" : "1.50",
"gatesgarth" : "1.48",
"dunfell" : "1.46",
}
# 3.4 onwards doesn't have poky version
# Early 3.4 release docs do reference it though
poky_mapping = {
"3.4" : "26.0",
"3.3" : "25.0",
"3.2" : "24.0",
"3.1" : "23.0",
}
ourseries = None
ourbranch = None
bitbakeversion = None
docconfver = None
# Test tags exist and inform the user to fetch if not
try:
subprocess.run(["git", "show", "yocto-%s" % release_series[activereleases[0]]], capture_output=True, check=True)
except subprocess.CalledProcessError:
sys.exit("Please run 'git fetch --tags' before building the documentation")
# Try and figure out what we are
tags = subprocess.run(["git", "tag", "--points-at", "HEAD"], capture_output=True, text=True).stdout
for t in tags.split():
if t.startswith("yocto-"):
ourversion = t[6:]
if ourversion:
# We're a tagged release
components = ourversion.split(".")
baseversion = components[0] + "." + components[1]
docconfver = ourversion
for i in release_series:
if release_series[i] == baseversion:
ourseries = i
ourbranch = i
if i in bitbake_mapping:
bitbakeversion = bitbake_mapping[i]
else:
# We're floating on a branch
branch = subprocess.run(["git", "branch", "--show-current"], capture_output=True, text=True).stdout.strip()
ourbranch = branch
if branch != "master" and branch not in release_series:
# We're not on a known release branch so we have to guess. Compare the numbers of commits
# from each release branch and assume the smallest number of commits is the one we're based off
possible_branch = None
branch_count = 0
for b in itertools.chain(release_series.keys(), ["master"]):
result = subprocess.run(["git", "log", "--format=oneline", "HEAD..origin/" + b], capture_output=True, text=True)
if result.returncode == 0:
count = result.stdout.count('\n')
if not possible_branch or count < branch_count:
print("Branch %s has count %s" % (b, count))
possible_branch = b
branch_count = count
if possible_branch:
branch = possible_branch
else:
branch = "master"
print("Nearest release branch estimated to be %s" % branch)
if branch == "master":
ourseries = devbranch
docconfver = "dev"
bitbakeversion = "dev"
elif branch in release_series:
ourseries = branch
if branch in bitbake_mapping:
bitbakeversion = bitbake_mapping[branch]
else:
sys.exit("Unknown series for branch %s" % branch)
previoustags = subprocess.run(["git", "tag", "--merged", "HEAD"], capture_output=True, text=True).stdout
previoustags = [t[6:] for t in previoustags.split() if t.startswith("yocto-" + release_series[ourseries])]
futuretags = subprocess.run(["git", "tag", "--merged", ourbranch], capture_output=True, text=True).stdout
futuretags = [t[6:] for t in futuretags.split() if t.startswith("yocto-" + release_series[ourseries])]
# Append .999 against the last known version
if len(previoustags) != len(futuretags):
ourversion = previoustags[-1] + ".999"
else:
ourversion = release_series[ourseries] + ".999"
if not docconfver:
docconfver = ourversion
series = [k for k in release_series]
previousseries = series[series.index(ourseries)+1:] or [""]
lastlts = [k for k in previousseries if k in ltsseries] or "dunfell"
print("Version calculated to be %s" % ourversion)
print("Release series calculated to be %s" % ourseries)
replacements = {
"DISTRO" : ourversion,
"DISTRO_NAME_NO_CAP" : ourseries,
"DISTRO_NAME" : ourseries.capitalize(),
"DISTRO_NAME_NO_CAP_MINUS_ONE" : previousseries[0],
"DISTRO_NAME_NO_CAP_LTS" : lastlts[0],
"YOCTO_DOC_VERSION" : ourversion,
"DISTRO_REL_TAG" : "yocto-" + ourversion,
"DOCCONF_VERSION" : docconfver,
"BITBAKE_SERIES" : bitbakeversion,
}
if release_series[ourseries] in poky_mapping:
pokyversion = poky_mapping[release_series[ourseries]]
if ourversion != release_series[ourseries]:
pokyversion = pokyversion + "." + ourversion.rsplit(".", 1)[1]
else:
pokyversion = pokyversion + ".0"
replacements["POKYVERSION"] = pokyversion
if os.path.exists("poky.yaml.in"):
with open("poky.yaml.in", "r") as r, open("poky.yaml", "w") as w:
lines = r.readlines()
for line in lines:
data = line.split(":")
k = data[0].strip()
if k in replacements:
w.write("%s : \"%s\"\n" % (k, replacements[k]))
else:
w.write(line)
print("poky.yaml generated from poky.yaml.in")
# In the switcher list of versions we display:
# - latest dev
# - latest stable release
# - latest LTS
# - latest for each releases listed as active
# - latest doc version in current series
# - current doc version
# (with duplicates removed)
versions = []
with open("sphinx-static/switchers.js.in", "r") as r, open("sphinx-static/switchers.js", "w") as w:
lines = r.readlines()
for line in lines:
if "ALL_RELEASES_PLACEHOLDER" in line:
w.write(str(list(release_series.keys())))
continue
if "VERSIONS_PLACEHOLDER" in line:
w.write(" 'dev': { 'title': 'Unstable (dev)', 'obsolete': false,},\n")
for branch in activereleases + ([ourseries] if ourseries not in activereleases else []):
if branch == devbranch:
continue
branch_versions = subprocess.run('git tag --list yocto-%s*' % (release_series[branch]), shell=True, capture_output=True, text=True).stdout.split()
branch_versions = sorted([v.replace("yocto-" + release_series[branch] + ".", "").replace("yocto-" + release_series[branch], "0") for v in branch_versions], key=int)
if not branch_versions:
continue
version = release_series[branch]
if branch_versions[-1] != "0":
version = version + "." + branch_versions[-1]
versions.append(version)
w.write(" '%s': {'title': '%s (%s)', 'obsolete': %s,},\n" % (version, branch.capitalize(), version, str(branch not in activereleases).lower()))
if ourversion not in versions and ourseries != devbranch:
w.write(" '%s': {'title': '%s (%s)', 'obsolete': %s,},\n" % (ourversion, ourseries.capitalize(), ourversion, str(ourseries not in activereleases).lower()))
else:
w.write(line)
print("switchers.js generated from switchers.js.in")
# generate releases.rst
# list missing tags in yocto-docs
missing_tags = [
'yocto-0.9',
'yocto-1.0', 'yocto-1.0.1',
'yocto-1.1', 'yocto-1.1.1',
'yocto-1.2',
'yocto-1.4.4', 'yocto-1.4.5',
'yocto-1.5', 'yocto-1.5.2', 'yocto-1.5.3', 'yocto-1.5.4',
'yocto-1.6', 'yocto-1.6.1', 'yocto-1.6.2',
'yocto-1.7', 'yocto-1.7.1',
'yocto-1.9',
'yocto-2.5.3',
'yocto-3.1', 'yocto-3.1.1', 'yocto-3.1.2', 'yocto-3.1.3',
]
semver = re.compile(r'yocto-(\d+)\.(\d+)(?:\.)?(\d*)')
# git is able to properly order semver versions but not python
# instead of adding a dependency on semver module, let's convert the version
# into a decimal number, e.g. 11.23.1 will be 112301 and 1.5 will be 010500 so
# it can be used as a key for the sorting algorithm.
# This can be removed once all the old tags are re-created.
def tag_to_semver_like(v):
v_semver = semver.search(v)
v_maj, v_min, v_patch = v_semver.groups('0')
return int("{:0>2}{:0>2}{:0>2}".format(v_maj, v_min, v_patch), 10)
yocto_tags = subprocess.run(["git", "tag", "--list", "--sort=version:refname", "yocto-*"], capture_output=True, text=True).stdout
yocto_tags = sorted(yocto_tags.split() + missing_tags, key=tag_to_semver_like)
tags = [tag[6:] for tag in yocto_tags]
with open('releases.rst', 'w') as f:
f.write('===========================\n')
f.write(' Supported Release Manuals\n')
f.write('===========================\n')
f.write('\n')
for activerelease in activereleases:
title = "Release Series %s (%s)" % (release_series[activerelease], activerelease)
f.write('*' * len(title) + '\n')
f.write(title + '\n')
f.write('*' * len(title) + '\n')
f.write('\n')
for tag in tags:
if tag == release_series[activerelease] or tag.startswith('%s.' % release_series[activerelease]):
f.write('- :yocto_docs:`%s Documentation </%s>`\n' % (tag, tag))
f.write('\n')
f.write('==========================\n')
f.write(' Outdated Release Manuals\n')
f.write('==========================\n')
f.write('\n')
for series in release_series:
if series == devbranch or series in activereleases:
continue
if series == "jethro-pre":
continue
title = "Release Series %s (%s)" % (release_series[series], series)
f.write('*' * len(title) + '\n')
f.write(title + '\n')
f.write('*' * len(title) + '\n')
f.write('\n')
if series == "jethro":
f.write('- :yocto_docs:`1.9 Documentation </1.9>`\n')
for tag in tags:
if tag == release_series[series] or tag.startswith('%s.' % release_series[series]):
f.write('- :yocto_docs:`%s Documentation </%s>`\n' % (tag, tag))
f.write('\n')
|