/
Makefile
635 lines (567 loc) · 24.5 KB
/
Makefile
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
##
## Build procedure for www.openssl.org
## Checkouts.
CHECKOUTS = /var/cache/openssl/checkouts
## Snapshot directory
SNAP = $(CHECKOUTS)/openssl
## OMC data directory
OMCDATA = $(CHECKOUTS)/data
## Where releases are found.
RELEASEDIR = /srv/ftp/source
## The OMC repository checkout can be used for dependencies.
## By default, we don't assume it, as not everyone has access to it.
## If you have it, do 'make PERSONDB=PATH/TO/omc/persondb.yaml' where
## PATH/TO/omc is the checked out OMC repository.
## We let it be FORCE by default... This forces the production of files
## that depend on this database, instead of just conditionally.
PERSONDB=FORCE
######################################################################
##
## Release series. These represent our release branches, and are
## our foundation for what should be built and how (often generated)
##
## The numbers given here RULE
##
## Current series. Variable names are numbered to indicate:
##
## SERIES1 OpenSSL pre-3.0
## SERIES3 OpenSSL 3.0 and on
## SERIES The concatenation of the above, for ease of use
##
## We mostly use $(SERIES) further down, but there are places where we
## need to make the distinction, because certain files are produced
## differently.
SERIES1=
SERIES3=3.3 3.2 3.1 3.0
SERIES=$(SERIES3) $(SERIES1)
## Older series. The second type is for source listings
OLDSERIES=1.1.1 1.1.0 1.0.2 1.0.1 1.0.0 0.9.8 0.9.7 0.9.6
OLDSERIES2=1.1.1 1.1.0 1.0.2 1.0.1 1.0.0 0.9.x
## Series for manual layouts, named similar to SERIES1, SERIES3, SERIES
MANSERIES1=1.1.1 1.0.2
MANSERIES3=3.3 3.2 3.1 3.0
MANSERIES=$(MANSERIES3) $(MANSERIES1)
## Future series, i.e. a series that hasn't had any final release yet.
## This would typically be a major or minor version that's still only
## on the master branch, but that has come far enough for us to start
## to make alpha and beta releases.
## We distinguish them to avoid having to produce notes, vulnerability
## documents, ... but still being able to present tarballs.
FUTURESERIES=
# All simple generated files.
# The H_ variables hold renderings of .md files present in the local
# repository. This does not include .md files taken from other repositories,
# they have their own special handling.
H_TOP = $(addsuffix .html,\
$(basename $(shell git ls-files -- *.md | grep -v '^README')) \
$(basename $(basename $(shell git ls-files -- *.md.tt))))
H_COMMUNITY = $(addsuffix .html,\
$(basename $(shell git ls-files -- community/*.md)) \
$(basename $(basename $(shell git ls-files -- community/*.md.tt))))
# We filter out any file starting with 'sub-'... they get special treatment
H_DOCS = $(addsuffix .html,\
$(basename $(shell git ls-files -- docs/*.md \
docs/*.md.tt \
| grep -v '/sub-')))
H_NEWS = $(addsuffix .html,\
$(basename $(shell git ls-files -- news/*.md)) \
$(basename $(basename $(shell git ls-files -- news/*.md.tt))))
H_POLICIES = $(addsuffix .html,\
$(basename $(shell git ls-files -- \
policies/*.md \
policies/general/*.md \
policies/technical/*.md \
policies/general-supplemental/*.md)) \
$(basename $(basename $(shell git ls-files -- \
policies/general/*.md.tt \
policies/technical/*.md.tt))))
# We filter out any file starting with 'sub-'... they get special treatment
H_SOURCE= $(addsuffix .html,\
$(basename $(shell git ls-files -- source/*.md \
source/old/*.md \
| grep -v '/sub-') \
$(basename $(shell git ls-files -- source/*.md.tt \
source/old/*.md.tt \
| grep -v '/sub-'))))
H_SUPPORT = $(addsuffix .html,$(basename $(shell git ls-files -- support/*.md)))
SIMPLE = $(H_TOP) \
$(H_COMMUNITY) \
$(foreach S,$(SERIES),news/openssl-$(S)-notes.html) \
$(H_NEWS) \
news/secadv \
news/secjson \
$(foreach S,$(SERIES) $(OLDSERIES),news/vulnerabilities-$(S).html) \
$(H_POLICIES) \
policies/glossary.html \
$(H_SOURCE) \
source/.htaccess \
$(H_SUPPORT)
SRCLISTS = $(foreach S,$(FUTURESERIES) $(SERIES) $(OLDSERIES2) fips,source/old/$(S)/index.html)
SIMPLEDOCS = $(H_DOCS) \
docs/OpenSSLStrategicArchitecture.html \
docs/OpenSSL300Design.html \
docs/manpages.html
GLOSSARY=$(CHECKOUTS)/general-policies/policies/glossary.md
all_GENERAL_POLICIES=$(wildcard $(CHECKOUTS)/general-policies/policies/*.md)
all_GENERAL_POLICY_SUPPL=$(wildcard $(CHECKOUTS)/general-policies/policy-supplemental/*.md)
all_TECHNICAL_POLICIES=$(wildcard $(CHECKOUTS)/technical-policies/policies/*.md)
GENERAL_POLICIES=$(filter-out $(CHECKOUTS)/general-policies/policies/README.md $(GLOSSARY),$(all_GENERAL_POLICIES))
GENERAL_POLICY_SUPPL=$(filter-out $(CHECKOUTS)/general-policies/policy-supplemental/README.md,$(all_GENERAL_POLICY_SUPPL))
TECHNICAL_POLICIES=$(filter-out $(CHECKOUTS)/technical-policies/policies/README.md,$(all_TECHNICAL_POLICIES))
.PHONY : FORCE
%.html : %.md bin/md-to-html5
@rm -f $@
./bin/md-to-html5 $<
% : %.tt bin/from-tt
@rm -f $@
./bin/from-tt $<
all: suball subdocs manmastertts mancross manhtml akamai-purge
suball: $(SIMPLE) $(SRCLISTS)
relupd: suball docs akamai-purge
docs: subdocs manpagetts mancross manhtml
subdocs: $(SIMPLEDOCS)
clean:
rm -rf $(SIMPLE) $(SIMPLEDOCS) $(SRCLISTS)
akamai-purge:
# Legacy targets
hack-source_htaccess: all
simple: all
generated: all
rebuild: all
# For our use of pandoc for full documents, we create a template suitable
# for us.
inc/pandoc-template.html5: inc/pandoc-header.html5 inc/pandoc-body-prologue.html5 inc/pandoc-body-epilogue.html5 bin/mk-pandoc-template Makefile
pandoc --print-default-template=html5 \
| ./bin/mk-pandoc-template html5 > $@
# Make bin/md-to-html5 depend on inc/pandoc-template.html5
bin/md-to-html5: inc/pandoc-template.html5
######################################################################
##
## Man-page building section
##
## This is quite a complex set of rules, because there are many
## things that need to be built:
##
## - The man-pages themselves
## - Apropos-like listings
## - Cross-references between man-pages in different OpenSSL
## versions
##
## A lot of the work is made with generated rules.
# makemanpagetts1 and makemanpagetts3 creates rules for targets like man-pagetts-1.1.1,
# to build the set of man-page templates. makemanpagetts1 is used for pre-3.0 OpenSSL,
# while makemanpagetts3 is used for OpenSSL 3.0 and on.
# makemanapropos creates rules for targets like man-apropos-1.1.1, to build
# 'apropos' like indexes for all the manpages.
# makemanindexes creates rules for targets like man-index-1.1.1, to build the
# main HTML index for a set of man-pages.
#
# $(1) = input directory in CHECKOUTS, $(2) = release version
# This variant is for pre-3.0 documentation
define makemanpagetts1
man-pagetts-$(2):
@rm -rf docs/man$(2)
@mkdir -p docs/man$(2) \
docs/man$(2)/man1 \
docs/man$(2)/man3 \
docs/man$(2)/man5 \
docs/man$(2)/man7
./bin/mk-manpagetts $(CHECKOUTS)/$(1)/doc $(2) docs/man$(2)
endef
# This variant is for 3.0 documentation
define makemanpagetts3
man-pagetts-$(2):
@rm -rf docs/man$(2)
@mkdir -p docs/man$(2) \
docs/man$(2)/man1 \
docs/man$(2)/man3 \
docs/man$(2)/man5 \
docs/man$(2)/man7
./bin/mk-manpagetts3 $(CHECKOUTS)/$(1) $(2) docs/man$(2)
endef
define makemanapropos
docs/man$(2)/man1/index.inc: bin/mk-apropos Makefile
./bin/mk-apropos docs/man$(2)/man1 > $$@
docs/man$(2)/man3/index.inc: bin/mk-apropos Makefile
./bin/mk-apropos docs/man$(2)/man3 > $$@
docs/man$(2)/man5/index.inc: bin/mk-apropos Makefile
./bin/mk-apropos docs/man$(2)/man5 > $$@
docs/man$(2)/man7/index.inc: bin/mk-apropos Makefile
./bin/mk-apropos docs/man$(2)/man7 > $$@
endef
define makemanindexes
docs/man$(2)/man1/index.md: docs/sub-man1-index.md.tt \
docs/man$(2)/man1/index.inc \
bin/from-tt Makefile
./bin/from-tt -d docs/man$(2)/man1 \
releases='$(MANSERIES)' release='$(2)' \
< $$< > $$@
docs/man$(2)/man3/index.md: docs/sub-man3-index.md.tt \
docs/man$(2)/man3/index.inc \
bin/from-tt Makefile
./bin/from-tt -d docs/man$(2)/man3 \
releases='$(MANSERIES)' release='$(2)' \
< $$< > $$@
docs/man$(2)/man5/index.md: docs/sub-man5-index.md.tt \
docs/man$(2)/man5/index.inc \
bin/from-tt Makefile
./bin/from-tt -d docs/man$(2)/man5 \
releases='$(MANSERIES)' release='$(2)' \
< $$< > $$@
docs/man$(2)/man7/index.md: docs/sub-man7-index.md.tt \
docs/man$(2)/man7/index.inc \
bin/from-tt Makefile
./bin/from-tt -d docs/man$(2)/man7 \
releases='$(MANSERIES)' release='$(2)' \
< $$< > $$@
docs/man$(2)/index.md: docs/sub-index.md.tt bin/from-tt Makefile
./bin/from-tt -d docs/man$(2) \
releases='$(MANSERIES)' release='$(2)' \
< $$< > $$@
endef
define makemandirdata
docs/man$(2)/man1/dirdata.yaml: docs/sub-dirdata.yaml.tt bin/from-tt Makefile
./bin/from-tt -d docs/man$(2)/man1 \
releases='$(MANSERIES)' release='$(2)' sectnum=1 \
< $$< > $$@
docs/man$(2)/man3/dirdata.yaml: docs/sub-dirdata.yaml.tt bin/from-tt Makefile
./bin/from-tt -d docs/man$(2)/man3 \
releases='$(MANSERIES)' release='$(2)' sectnum=3 \
< $$< > $$@
docs/man$(2)/man5/dirdata.yaml: docs/sub-dirdata.yaml.tt bin/from-tt Makefile
./bin/from-tt -d docs/man$(2)/man5 \
releases='$(MANSERIES)' release='$(2)' sectnum=5 \
< $$< > $$@
docs/man$(2)/man7/dirdata.yaml: docs/sub-dirdata.yaml.tt bin/from-tt Makefile
./bin/from-tt -d docs/man$(2)/man7 \
releases='$(MANSERIES)' release='$(2)' sectnum=7 \
< $$< > $$@
docs/man$(2)/dirdata.yaml: docs/sub-dirdata.yaml.tt bin/from-tt Makefile
./bin/from-tt -d docs/man$(2) \
releases='$(MANSERIES)' release='$(2)' \
< $$< > $$@
endef
define makemanuals1
$(eval $(call makemanpagetts1,$(1),$(2)))
$(eval $(call makemanapropos,$(1),$(2)))
$(eval $(call makemanindexes,$(1),$(2)))
$(eval $(call makemandirdata,$(1),$(2)))
endef
define makemanuals3
$(eval $(call makemanpagetts3,$(1),$(2)))
$(eval $(call makemanapropos,$(1),$(2)))
$(eval $(call makemanindexes,$(1),$(2)))
$(eval $(call makemandirdata,$(1),$(2)))
endef
# Now that we have the generating macros in place, let's use them!
#
# Start off with creating the 'manpages-master' target, taking the
# source from $(CHECKOUTS)/openssl/doc
$(eval $(call makemanuals3,openssl,master))
# Next, create 'manpages-x.y' for all current releases from 3.0 and on,
# taking the source from $(CHECKOUTS)/openssl-x.y/doc
$(foreach S,$(MANSERIES3),$(eval $(call makemanuals3,openssl-$(S),$(S))))
# Next, create 'manpages-x.y.z' for all current pre-3.0 releases, taking the
# source from $(CHECKOUTS)/openssl-x.y.z-stable/doc
$(foreach S,$(MANSERIES1),$(eval $(call makemanuals1,openssl-$(S)-stable,$(S))))
MANMASTER_DIRS = \
$(foreach SEC,1 3 5 7, docs/manmaster/man$(SEC))
MANMASTERTT_TARGETS = \
man-pagetts-master \
docs/manmaster/dirdata.yaml docs/manmaster/index.html \
$(foreach D,$(MANMASTER_DIRS), $(D)/dirdata.yaml $(D)/index.html)
manmastertts: $(MANMASTERTT_TARGETS)
MANPAGE_DIRS = \
$(foreach S,$(MANSERIES), \
$(foreach SEC,1 3 5 7, docs/man$(S)/man$(SEC)))
MANPAGETT_TARGETS = \
$(foreach S,$(MANSERIES), man-pagetts-$(S) \
docs/man$(S)/dirdata.yaml docs/man$(S)/index.html) \
$(foreach D,$(MANPAGE_DIRS), $(D)/dirdata.yaml $(D)/index.html)
manpagetts: manmastertts $(MANPAGETT_TARGETS)
mancross:
./bin/mk-mancross master $(MANSERIES)
# We can't get all the files when make is started, but we can make the
# patterns for a for loop.
MANHTML_TTPATTERNS=$(foreach D,$(MANMASTER_DIRS) $(MANPAGE_DIRS), $(D)/*.md.tt)
manhtml:
./bin/mk-manhtml '$(MANHTML_TTPATTERNS)'
docs/manpages.md: docs/manpages.md.tt Makefile bin/from-tt
@rm -f $@
./bin/from-tt releases='master $(MANSERIES)' $<
docs/mansidebar.html: docs/mansidebar.html.tt Makefile bin/from-tt
@rm -f $@
./bin/from-tt releases='master $(MANSERIES)' $<
######################################################################
##
## Policy page building section
##
.PHONY: technical-policies
technical-policies: $(TECHNICAL_POLICIES) policies/technical/dirdata.yaml \
bin/md-to-html5
mkdir -p policies/technical
for x in $(TECHNICAL_POLICIES); do \
d=$$(dirname $$x); \
f=$$(basename $$x .md); \
cat "$$x" \
| sed -E -e 's!https?://github\.com/openssl/(general|technical)-policies/blob/master/policies/(.*)\.md!../\1/\2.html!' \
| sed -E -e 's!https?://github\.com/openssl/(general|technical)-policies/blob/master/policy-supplemental/(.*)\.md!../\1-supplemental/\2.html!' \
| sed -E -e 's!\.\./general/glossary\.html!../glossary.html!' \
| ./bin/md-to-html5 -o policies/technical/"$$f".html; \
done
policies/technical/index.inc: technical-policies bin/mk-md-titlelist Makefile
./bin/mk-md-titlelist '' $(TECHNICAL_POLICIES) > $@
policies/technical/index.md: policies/technical/index.inc
policies/technical/dirdata.yaml: policies/technical/index.inc
policies/technical/index.html: policies/technical/index.md
.PHONY: general-policies
general-policies: $(GENERAL_POLICIES) policies/general/dirdata.yaml \
bin/md-to-html5
mkdir -p policies/general
for x in $(GENERAL_POLICIES); do \
d=$$(dirname "$$x"); \
f=$$(basename "$$x" .md); \
cat "$$x" \
| sed -E -e 's!https?://github\.com/openssl/(general|technical)-policies/blob/master/policies/(.*)\.md!../\1/\2.html!' \
| sed -E -e 's!https?://github\.com/openssl/(general|technical)-policies/blob/master/policy-supplemental/(.*)\.md!../\1-supplemental/\2.html!' \
| sed -E -e 's!\.\./policy-supplemental/(.*)\.html!../general-supplemental/\1.html!' \
| sed -E -e 's!\.\./general/glossary\.html!../glossary.html!' \
| ./bin/md-to-html5 -o policies/general/"$$f".html; \
done
policies/general/index.inc: general-policies general-policy-supplemental bin/mk-md-titlelist Makefile
./bin/mk-md-titlelist '' $(GENERAL_POLICIES) > $@
policies/general/index.md: policies/general/index.inc
policies/general/dirdata.yaml: policies/general/index.inc
policies/general/index.html: policies/general/index.md
.PHONY: general-policy-supplemental
general-policy-supplemental: $(GENERAL_POLICY_SUPPL) bin/md-to-html5
mkdir -p policies/general-supplemental
for x in $(GENERAL_POLICY_SUPPL); do \
d=$$(dirname "$$x"); \
f=$$(basename "$$x" .md); \
cat "$$x" \
| ./bin/md-to-html5 -o policies/general-supplemental/"$$f".html; \
done
policies/glossary.html: $(GLOSSARY) bin/md-to-html5 policies/dirdata.yaml
cat "$(GLOSSARY)" \
| sed -E -e 's!https?://github\.com/openssl/(general|technical)-policies/blob/master/policies/(.*)\.md!\1/\2.html!' \
| sed -E -e 's!general/glossary\.html!glossary.html!' \
| ./bin/md-to-html5 -o policies/glossary.html
######################################################################
##
## $(SIMPLE) -- SIMPLE GENERATED FILES
##
.PHONY:
newsflash.inc: news/newsflash.inc
@rm -f $@
head -7 $< >$@
index.md: newsflash.inc inc/legalities.md
community/committers.inc: $(PERSONDB) bin/mk-committers Makefile
@rm -f $@
wget -q https://api.openssl.org/0/Group/commit/Members
./bin/mk-committers <Members >$@
@rm -f Members
community/committers.md: community/committers.inc
community/otc.inc: $(PERSONDB) bin/mk-omc Makefile
./bin/mk-omc -n -p -t 'OTC Members' otc otc-inactive > $@
community/otc.md: community/otc.inc
community/omc.inc: $(PERSONDB) bin/mk-omc Makefile
./bin/mk-omc -n -e -l -p -t 'OMC Members' omc omc-inactive > $@
community/omc.md: community/omc.inc
community/omc-alumni.inc: $(PERSONDB) bin/mk-omc Makefile
./bin/mk-omc -n -l -t 'OMC Alumni' omc-alumni omc-emeritus > $@
community/omc-alumni.md: community/omc-alumni.inc
news/changelog.inc: news/changelog.txt bin/post-process-html5 Makefile
@rm -f $@
(echo 'Table of contents'; sed -e '1,/^OpenSSL Releases$$/d' < $<) \
| pandoc -t html5 -f commonmark | ./bin/post-process-html5 >$@
news/changelog.md: news/changelog.md.tt news/changelog.inc \
bin/from-tt Makefile
@rm -f $@
./bin/from-tt 'releases=$(SERIES)' $<
# Additionally, make news/changelog.html depend on clxy[z].txt, where xy[z]
# comes from the release number x.y[.z]. This permits it to be automatically
# recreated whenever there's a new major release.
news/changelog.html: $(foreach S,$(SERIES),news/cl$(subst .,,$(S)).txt)
# mknews_changelogtxt creates a target and ruleset for any changelog text
# file depending on the CHANGES file from the target release.
#
# $(1) = output file, $(2) = CHANGES files, relative to CHECKOUTS
define mknews_changelogtxt
news/$(1): $(CHECKOUTS)/$(2)
@rm -f $$@
cp $$< $$@
endef
# Create the target 'news/changelog.txt', taking the source from
# $(CHECKOUTS)/openssl/CHANGES.md
# We use the .txt extension for multiple purposes:
# 1. So the web server maps to the MIME type text/plain
# 2. To ensure there's no need to publish any .md file (since they're all
# supposed to be used to generate .html files)
# 3. Because it was changelog.txt before, a well known target. Why change it?
$(eval $(call mknews_changelogtxt,changelog.txt,openssl/CHANGES.md))
# Create the target 'news/clxy.md' for all releases from 3.0 and on, taking
# the source from $(CHECKOUTS)/openssl-x.y/CHANGES.md
$(foreach S,$(SERIES3),\
$(eval $(call mknews_changelogtxt,cl$(subst .,,$(S)).txt,openssl-$(S)/CHANGES.md)))
# Create the targets 'news/clxyz.txt' for all current pre-3.0 releases,
# taking the source from $(CHECKOUTS)/openssl-x.y.z-stable/CHANGES
$(foreach S,$(SERIES1),\
$(eval $(call mknews_changelogtxt,cl$(subst .,,$(S)).txt,openssl-$(S)-stable/CHANGES)))
# mknews_noteshtml creates two targets and rulesets for creating notes from
# the NEWS file for each release. One target is to create a wrapping HTML
# file from a template, the other is to create the inclusion file with the
# actual text.
#
# $(1) = release version, $(2) = NEWS file, relative to CHECKOUTS
define mknews_noteshtml
news/openssl-$(1)-notes.md: news/openssl-notes.md.tt \
news/openssl-$(1)-notes.inc \
bin/from-tt Makefile
@rm -f $$@
./bin/from-tt -d news -i $$< -o $$@ release='$(1)'
news/openssl-$(1)-notes.inc: $(CHECKOUTS)/$(2) bin/mk-notes Makefile
@rm -f $$@
./bin/mk-notes $(1) < $(CHECKOUTS)/$(2) > $$@
endef
# Create the targets 'news/openssl-x.y-notes.html' and
# 'news/openssl-x.y-notes.inc' for each release number x.y starting with 3.0,
# taking the source from the news file given as second argument.
$(foreach S,$(SERIES3),\
$(eval $(call mknews_noteshtml,$(S),openssl-$(S)/NEWS.md)))
# Create the targets 'news/openssl-x.y.z-notes.html' and
# 'news/openssl-x.y.z-notes.inc' for each pre-3.0 release number x.y.z,
# taking the source from the news file given as second argument.
$(foreach S,$(SERIES1),\
$(eval $(call mknews_noteshtml,$(S),openssl-$(S)-stable/NEWS)))
news/newsflash.inc: $(OMCDATA)/newsflash.txt Makefile
sed <$< >$@ \
-e '/^#/d' \
-e 's@^@<tr><td class="d">@' \
-e 's@: @</td><td class="t">@' \
-e 's@$$@</td></tr>@'
# mknews_vulnerability creates two targets and rulesets for creating
# vulnerability lists for each release. One target is to create a wrapping
# HTML file from a template, the other is to create the inclusion file with
# the actual text.
#
# $(1) = output file mod, $(2) = release version switch, $(3) = release version
define mknews_vulnerability
news/vulnerabilities$(1).inc: bin/cvejsontohtml.py news/secjson Makefile
@rm -f $$@
python3 ./bin/cvejsontohtml.py -i news/secjson/ $(2) > $$@
news/vulnerabilities$(1).md: news/vulnerabilities.md.tt \
news/vulnerabilities$(1).inc \
bin/from-tt Makefile
@rm -f $$@
./bin/from-tt -d news vulnerabilitiesinc='vulnerabilities$(1).inc' < $$< > $$@
endef
# Create the main vulnerability index 'news/vulnerabilities.html' and
# 'news/vulnerabilities.inc'
$(eval $(call mknews_vulnerability,,))
# Create the vulnerability index 'news/vulnerabilities-x.y[.z].html' and
# 'news/vulnerabilities-x.y[.z].inc' for each release x.y[.z]
$(foreach S,$(SERIES) $(OLDSERIES),\
$(eval $(call mknews_vulnerability,-$(S),-b $(S))))
source/.htaccess: $(wildcard source/openssl-*.tar.gz) bin/mk-latest Makefile
@rm -f @?
./bin/mk-latest $(RELEASEDIR) >$@
source/index.inc: $(wildcard $(RELEASEDIR)/openssl-*.tar.gz) bin/mk-filelist Makefile
@rm -f $@
./bin/mk-filelist $(RELEASEDIR) '' 'openssl-*.tar.gz' >$@
# mknews_secadv creates a target to copy a secadv file from $(OMCDATA)/secadv
# to news/secadv/.
# $(1) = file name
define mknews_secadv
news/secadv/$(1): $(OMCDATA)/secadv/$(1)
cp $$< $$@
endef
# mknews_secjson creates a target to copy a security json file from $(OMCDATA)/vulnerabilities-json
# to news/secjson/.
# $(1) = file name
define mknews_secjson
news/secjson/$(1): $(OMCDATA)/vulnerabilities-json/$(1)
cp $$< $$@
endef
# Get the set of files in $(OMCDATA)/secadv/
SECADV_FILES = $(shell cd $(OMCDATA)/secadv/; git ls-files)
$(foreach F,$(SECADV_FILES),$(eval $(call mknews_secadv,$(F))))
# Get the set of files in $(OMCDATA)/vulnerabilities-json/
SECJSON_FILES = $(shell cd $(OMCDATA)/vulnerabilities-json/; git ls-files)
$(foreach F,$(SECJSON_FILES),$(eval $(call mknews_secjson,$(F))))
mkdirnews_secadv: FORCE
mkdir -p news/secadv
news/secadv: mkdirnews_secadv $(addprefix news/secadv/,$(SECADV_FILES))
.PHONY: news/secadv mkdirnews_secadv
mkdirnews_secjson: FORCE
mkdir -p news/secjson
news/secjson: mkdirnews_secjson $(addprefix news/secjson/,$(SECJSON_FILES))
.PHONY: news/secjson mkdirnews_secjson
######################################################################
##
## $(SRCLISTS) -- LISTS OF SOURCES
##
# mkoldsourceindex creates two targets and rulesets for creating the
# list of update tarballs for each release. One target is to create a
# wrapping HTML file from a template, the other is to create the
# inclusion file with the actual text.
#
# $(1) = release, $(2) = release title
define mkoldsourceindex
source/old/$(1)/index.inc: $(RELEASEDIR)/old/$(1) bin/mk-filelist Makefile
@mkdir -p `dirname $$@`
@rm -f $$@
./bin/mk-filelist $(RELEASEDIR)/old/$(1) '' '*.gz' > $$@
source/old/$(1)/index.md: source/old/sub-index.md.tt inc/legalities.md \
source/old/$(1)/index.inc \
bin/from-tt Makefile
@mkdir -p `dirname $$@`
@rm -f $$@
./bin/from-tt -d source/old/$(1) \
release='$(1)' releasetitle='Old $(2) Releases' \
< $$< > $$@
endef
define mkoldsourcedirdata
source/old/$(1)/dirdata.yaml: source/old/sub-dirdata.yaml.tt bin/from-tt Makefile
@mkdir -p `dirname $$@`
@rm -f $$@
./bin/from-tt -d source/old/$(1) \
release='$(1)' releasetitle='Old $(2) Releases' \
< $$< > $$@
source/old/$(1)/index.html: source/old/$(1)/dirdata.yaml
endef
# Create the update tarball index 'source/old/x.y.z/index.html' and
# 'source/old/x.y.z/index.inc' for each release x.y.z.
# We also create a list specifically for the old FIPS module, carefully
# crafting an HTML title with an uppercase 'FIPS' while the subdirectory
# remains named 'fips'
$(foreach S,fips $(FUTURESERIES) $(SERIES) $(OLDSERIES2),$(eval $(call mkoldsourceindex,$(S),$(patsubst fips,FIPS,$(S)))))
$(foreach S,fips $(FUTURESERIES) $(SERIES) $(OLDSERIES2),$(eval $(call mkoldsourcedirdata,$(S),$(patsubst fips,FIPS,$(S)))))
source/old/index.md: source/old/index.md.tt inc/legalities.md \
Makefile bin/from-tt Makefile
@mkdir -p `dirname $@`
@rm -f $@
./bin/from-tt releases='$(FUTURESERIES) $(SERIES) $(OLDSERIES2) fips' $<
# Extra inc -> markdown dependencies
news/newslog.md: news/newsflash.inc
news/pgpkey.md: news/openssl-security.asc
source/index.md: source/index.inc
# Extra HTML dependencies (apart from the markdown file it comes from)
# makehtmldepend creates a standard dependency for HTML files rendered from
# markdown files
# $(1) = HTML file
define makehtmldepend
$(1): bin/md-to-html5 $(dir $(1))dirdata.yaml
endef
# Generate standard dependencies for our known HTML outputs.
$(foreach H, \
$(H_TOP) \
$(H_COMMUNITY) \
$(H_DOCS) \
$(filter %.html,$(MANMASTER_TARGETS)) \
$(filter %.html,$(MANPAGES_TARGETS)) \
$(H_NEWS) \
$(H_POLICIES) \
$(H_SOURCE) \
$(H_SUPPORT) \
,$(eval $(call makehtmldepend,$(H))))