1# $FreeBSD$
2#
3# Makefile for building releases and release media.
4#
5# User-driven targets:
6#  cdrom: Builds release CD-ROM media (disc1.iso)
7#  dvdrom: Builds release DVD-ROM media (dvd1.iso)
8#  memstick: Builds memory stick image (memstick.img)
9#  mini-memstick: Builds minimal memory stick image (mini-memstick.img)
10#  ftp: Sets up FTP distribution area (ftp)
11#  release: Build all media and FTP distribution area
12#  install: Copies all release media into ${DESTDIR}
13#
14# Variables affecting the build process:
15#  WORLDDIR: location of src tree -- must have built world and default kernel
16#            (by default, the directory above this one)
17#  PORTSDIR: location of ports tree to distribute (default: /usr/ports)
18#  DOCDIR:   location of doc tree (default: /usr/doc)
19#  NOPKG:    if set, do not distribute third-party packages
20#  NOPORTS:  if set, do not distribute ports tree
21#  NOSRC:    if set, do not distribute source tree
22#  NODOC:    if set, do not generate release documentation
23#  WITH_DVD: if set, generate dvd1.iso
24#  WITH_COMPRESSED_IMAGES: if set, compress installation images with xz(1)
25#		(uncompressed images are not removed)
26#  WITH_VMIMAGES: if set, build virtual machine images with the release
27#  WITH_COMPRESSED_VMIMAGES: if set, compress virtual machine disk images
28#  		with xz(1) (extremely time consuming)
29#  TARGET/TARGET_ARCH: architecture of built release
30#
31
32WORLDDIR?=	${.CURDIR}/..
33PORTSDIR?=	/usr/ports
34DOCDIR?=	/usr/doc
35RELNOTES_LANG?= en_US.ISO8859-1
36XZCMD?=		/usr/bin/xz
37
38.if !defined(TARGET) || empty(TARGET)
39TARGET=		${MACHINE}
40.endif
41.if !defined(TARGET_ARCH) || empty(TARGET_ARCH)
42.if ${TARGET} == ${MACHINE}
43TARGET_ARCH=	${MACHINE_ARCH}
44.else
45TARGET_ARCH=	${TARGET}
46.endif
47.endif
48IMAKE=		${MAKE} TARGET_ARCH=${TARGET_ARCH} TARGET=${TARGET}
49DISTDIR=	dist
50
51# Define OSRELEASE by using newvars.sh
52.if !defined(OSRELEASE) || empty(OSRELEASE)
53.for _V in TYPE BRANCH REVISION
54${_V}!=	eval $$(awk '/^${_V}=/{print}' ${.CURDIR}/../sys/conf/newvers.sh); echo $$${_V}
55.endfor
56.for _V in ${TARGET_ARCH}
57.if !empty(TARGET:M${_V})
58OSRELEASE=	${TYPE}-${REVISION}-${BRANCH}-${TARGET}
59VOLUME_LABEL=	${REVISION:C/[.-]/_/g}_${BRANCH:C/[.-]/_/g}_${TARGET}
60.else
61OSRELEASE=	${TYPE}-${REVISION}-${BRANCH}-${TARGET}-${TARGET_ARCH}
62VOLUME_LABEL=	${REVISION:C/[.-]/_/g}_${BRANCH:C/[.-]/_/g}_${TARGET_ARCH}
63.endif
64.endfor
65.endif
66
67.if !defined(VOLUME_LABEL) || empty(VOLUME_LABEL)
68VOLUME_LABEL=	FreeBSD_Install
69.endif
70
71.if !exists(${DOCDIR})
72NODOC= true
73.endif
74.if !exists(${PORTSDIR})
75NOPORTS= true
76.endif
77
78EXTRA_PACKAGES=
79.if !defined(NOPORTS)
80EXTRA_PACKAGES+= ports.txz
81.endif
82.if !defined(NOSRC)
83EXTRA_PACKAGES+= src.txz
84.endif
85.if !defined(NODOC)
86EXTRA_PACKAGES+= reldoc
87.endif
88
89RELEASE_TARGETS= ftp
90IMAGES=
91.if exists(${.CURDIR}/${TARGET}/mkisoimages.sh)
92RELEASE_TARGETS+= cdrom
93IMAGES+=	disc1.iso bootonly.iso
94. if defined(WITH_DVD) && !empty(WITH_DVD)
95RELEASE_TARGETS+= dvdrom
96IMAGES+=	dvd1.iso
97. endif
98.endif
99.if exists(${.CURDIR}/${TARGET}/make-memstick.sh)
100RELEASE_TARGETS+= memstick.img
101RELEASE_TARGETS+= mini-memstick.img
102IMAGES+=	memstick.img
103IMAGES+=	mini-memstick.img
104.endif
105.if exists(${.CURDIR}/${TARGET}/make-uefi-memstick.sh)
106RELEASE_TARGETS+=uefi-memstick.img
107RELEASE_TARGETS+=uefi-mini-memstick.img
108IMAGES+=	uefi-memstick.img
109IMAGES+=	uefi-mini-memstick.img
110.endif
111.if exists(${.CURDIR}/${TARGET}/mkisoimages-uefi.sh)
112RELEASE_TARGETS+=uefi-disc1.iso
113RELEASE_TARGETS+=uefi-bootonly.iso
114IMAGES+=	uefi-disc1.iso
115IMAGES+=	uefi-bootonly.iso
116. if defined(WITH_DVD) && !empty(WITH_DVD)
117RELEASE_TARGETS+=uefi-dvd1.iso
118IMAGES+=	uefi-dvd1.iso
119. endif
120.endif
121
122VMTARGETS=	vm-base vm-image
123VMFORMATS?=	vhd vmdk qcow2 raw
124VMSIZE?=	20G
125VMBASE?=	vm
126AZURECONF?=	${.CURDIR}/tools/azure.conf
127
128CLEANFILES=	packagesystem *.txz MANIFEST system ${IMAGES}
129.if defined(WITH_COMPRESSED_IMAGES) && !empty(WITH_COMPRESSED_IMAGES)
130. for I in ${IMAGES}
131CLEANFILES+=	${I}.xz
132. endfor
133.endif
134.if defined(WITH_DVD) && !empty(WITH_DVD)
135CLEANFILES+=	pkg-stage
136.endif
137.if defined(WITH_VMIMAGES) && !empty(WITH_VMIMAGES)
138CLEANFILES+=	${VMBASE}.img
139. for FORMAT in ${VMFORMATS}
140CLEANFILES+=	${VMBASE}.${FORMAT}
141. endfor
142.endif
143CLEANDIRS=	dist ftp release bootonly dvd
144.if defined(WITH_VMIMAGES) && !empty(WITH_VMIMAGES)
145CLEANDIRS+=	${VMTARGETS}
146.endif
147.if exists(${.CURDIR}/${TARGET}/mk-azure.sh)
148CLEANFILES+=	${OSRELEASE}.vhd \
149		${OSRELEASE}.vhd.raw \
150		azure.img
151CLEANDIRS+=	vm-azure
152.endif
153beforeclean:
154	chflags -R noschg .
155.include <bsd.obj.mk>
156clean: beforeclean
157
158base.txz:
159	mkdir -p ${DISTDIR}
160	cd ${WORLDDIR} && ${IMAKE} distributeworld DISTDIR=${.OBJDIR}/${DISTDIR}
161# Set up mergemaster root database
162	sh ${.CURDIR}/scripts/mm-mtree.sh -m ${WORLDDIR} -F \
163	    "TARGET_ARCH=${TARGET_ARCH} TARGET=${TARGET}" -D "${.OBJDIR}/${DISTDIR}/base"
164	etcupdate extract -B -M "TARGET_ARCH=${TARGET_ARCH} TARGET=${TARGET}" \
165	    -s ${WORLDDIR} -d "${.OBJDIR}/${DISTDIR}/base/var/db/etcupdate"
166# Package all components
167	cd ${WORLDDIR} && ${IMAKE} packageworld DISTDIR=${.OBJDIR}/${DISTDIR}
168	mv ${DISTDIR}/*.txz .
169
170kernel.txz:
171	mkdir -p ${DISTDIR}
172	cd ${WORLDDIR} && ${IMAKE} distributekernel packagekernel DISTDIR=${.OBJDIR}/${DISTDIR}
173	mv ${DISTDIR}/kernel*.txz .
174
175src.txz:
176	mkdir -p ${DISTDIR}/usr
177	ln -fs ${WORLDDIR} ${DISTDIR}/usr/src
178	cd ${DISTDIR} && tar cLvJf ${.OBJDIR}/src.txz --exclude .svn --exclude .zfs \
179	    --exclude .git --exclude @ --exclude usr/src/release/dist usr/src
180
181ports.txz:
182	mkdir -p ${DISTDIR}/usr
183	ln -fs ${PORTSDIR} ${DISTDIR}/usr/ports
184	cd ${DISTDIR} && tar cLvJf ${.OBJDIR}/ports.txz \
185	    --exclude .git --exclude .svn \
186	    --exclude usr/ports/distfiles --exclude usr/ports/packages \
187	    --exclude 'usr/ports/INDEX*' --exclude work usr/ports
188
189reldoc:
190	cd ${.CURDIR}/doc && ${MAKE} all install clean 'FORMATS=html txt' \
191	    INSTALL_COMPRESSED='' URLS_ABSOLUTE=YES DOCDIR=${.OBJDIR}/rdoc
192	mkdir -p reldoc
193.for i in hardware readme relnotes errata
194	ln -f rdoc/${RELNOTES_LANG}/${i}/article.txt reldoc/${i:tu}.TXT
195	ln -f rdoc/${RELNOTES_LANG}/${i}/article.html reldoc/${i:tu}.HTM
196.endfor
197	cp rdoc/${RELNOTES_LANG}/readme/docbook.css reldoc
198
199system: packagesystem
200# Install system
201	mkdir -p release
202	cd ${WORLDDIR} && ${IMAKE} installkernel installworld distribution \
203		DESTDIR=${.OBJDIR}/release WITHOUT_RESCUE=1 WITHOUT_KERNEL_SYMBOLS=1 \
204		WITHOUT_PROFILE=1 WITHOUT_SENDMAIL=1 WITHOUT_ATF=1 WITHOUT_LIB32=1
205# Copy distfiles
206	mkdir -p release/usr/freebsd-dist
207	cp *.txz MANIFEST release/usr/freebsd-dist
208# Copy documentation, if generated
209.if !defined(NODOC)
210	cp reldoc/* release
211.endif
212# Set up installation environment
213	ln -fs /tmp/bsdinstall_etc/resolv.conf release/etc/resolv.conf
214	echo sendmail_enable=\"NONE\" > release/etc/rc.conf
215	echo hostid_enable=\"NO\" >> release/etc/rc.conf
216	cp ${.CURDIR}/rc.local release/etc
217	touch ${.TARGET}
218
219bootonly: packagesystem
220# Install system
221	mkdir -p bootonly
222	cd ${WORLDDIR} && ${IMAKE} installkernel installworld distribution \
223	    DESTDIR=${.OBJDIR}/bootonly WITHOUT_AMD=1 WITHOUT_AT=1 \
224	    WITHOUT_GAMES=1 WITHOUT_GROFF=1 \
225	    WITHOUT_INSTALLLIB=1 WITHOUT_LIB32=1 WITHOUT_MAIL=1 \
226	    WITHOUT_NCP=1 WITHOUT_TOOLCHAIN=1 WITHOUT_PROFILE=1 \
227	    WITHOUT_INSTALLIB=1 WITHOUT_RESCUE=1 WITHOUT_DICT=1 \
228	    WITHOUT_KERNEL_SYMBOLS=1
229# Copy manifest only (no distfiles) to get checksums
230	mkdir -p bootonly/usr/freebsd-dist
231	cp MANIFEST bootonly/usr/freebsd-dist
232# Copy documentation, if generated
233.if !defined(NODOC)
234	cp reldoc/* bootonly
235.endif
236# Set up installation environment
237	ln -fs /tmp/bsdinstall_etc/resolv.conf bootonly/etc/resolv.conf
238	echo sendmail_enable=\"NONE\" > bootonly/etc/rc.conf
239	echo hostid_enable=\"NO\" >> bootonly/etc/rc.conf
240	cp ${.CURDIR}/rc.local bootonly/etc
241
242dvd:
243# Install system
244	mkdir -p ${.TARGET}
245	cd ${WORLDDIR} && ${IMAKE} installkernel installworld distribution \
246		DESTDIR=${.OBJDIR}/${.TARGET} WITHOUT_RESCUE=1 WITHOUT_KERNEL_SYMBOLS=1
247# Copy distfiles
248	mkdir -p ${.TARGET}/usr/freebsd-dist
249	cp *.txz MANIFEST ${.TARGET}/usr/freebsd-dist
250# Copy documentation, if generated
251.if !defined(NODOC)
252	cp reldoc/* ${.TARGET}
253.endif
254# Set up installation environment
255	ln -fs /tmp/bsdinstall_etc/resolv.conf ${.TARGET}/etc/resolv.conf
256	echo sendmail_enable=\"NONE\" > ${.TARGET}/etc/rc.conf
257	echo hostid_enable=\"NO\" >> ${.TARGET}/etc/rc.conf
258	cp ${.CURDIR}/rc.local ${.TARGET}/etc
259	touch ${.TARGET}
260
261release.iso: disc1.iso
262disc1.iso: system
263	sh ${.CURDIR}/${TARGET}/mkisoimages.sh -b ${VOLUME_LABEL}_CD ${.TARGET} release
264
265uefi-disc1.iso: system
266.if exists(${.CURDIR}/${TARGET}/mkisoimages-uefi.sh)
267	sh ${.CURDIR}/${TARGET}/mkisoimages-uefi.sh -b ${VOLUME_LABEL}_UEFICD \
268		${.TARGET} release
269.endif
270
271uefi-bootonly.iso: bootonly
272.if exists(${.CURDIR}/${TARGET}/mkisoimages-uefi.sh)
273	sh ${.CURDIR}/${TARGET}/mkisoimages-uefi.sh -b ${VOLUME_LABEL}_UEFIBO \
274		${.TARGET} bootonly
275.endif
276
277dvd1.iso: dvd pkg-stage
278	sh ${.CURDIR}/${TARGET}/mkisoimages.sh -b ${VOLUME_LABEL}_DVD ${.TARGET} dvd
279
280uefi-dvd1.iso: dvd pkg-stage
281.if exists(${.CURDIR}/${TARGET}/mkisoimages-uefi.sh)
282	sh ${.CURDIR}/${TARGET}/mkisoimages-uefi.sh -b ${VOLUME_LABEL}_UEFIDVD \
283		${.TARGET} dvd
284.endif
285
286bootonly.iso: bootonly
287	sh ${.CURDIR}/${TARGET}/mkisoimages.sh -b ${VOLUME_LABEL}_BO ${.TARGET} bootonly
288
289memstick: memstick.img
290memstick.img: system
291	sh ${.CURDIR}/${TARGET}/make-memstick.sh release ${.TARGET}
292
293mini-memstick: mini-memstick.img
294mini-memstick.img: system
295	sh ${.CURDIR}/${TARGET}/make-memstick.sh bootonly ${.TARGET}
296
297uefi-memstick: uefi-memstick.img
298uefi-memstick.img: system
299.if exists(${.CURDIR}/${TARGET}/make-uefi-memstick.sh)
300	sh ${.CURDIR}/${TARGET}/make-uefi-memstick.sh release ${.TARGET}
301.endif
302
303uefi-mini-memstick: uefi-mini-memstick.img
304uefi-mini-memstick.img: system
305.if exists(${.CURDIR}/${TARGET}/make-uefi-memstick.sh)
306	sh ${.CURDIR}/${TARGET}/make-uefi-memstick.sh bootonly ${.TARGET}
307.endif
308
309packagesystem: base.txz kernel.txz ${EXTRA_PACKAGES}
310	sh ${.CURDIR}/scripts/make-manifest.sh *.txz > MANIFEST
311	touch ${.TARGET}
312
313pkg-stage:
314.if !defined(NOPKG)
315	env REPOS_DIR=${.CURDIR}/pkg_repos/ \
316		sh ${.CURDIR}/scripts/pkg-stage.sh
317	mkdir -p ${.OBJDIR}/dvd/packages/repos/
318	cp ${.CURDIR}/scripts/FreeBSD_install_cdrom.conf \
319		${.OBJDIR}/dvd/packages/repos/
320.endif
321	touch ${.TARGET}
322
323cdrom: disc1.iso bootonly.iso
324dvdrom: dvd1.iso
325ftp: packagesystem
326	rm -rf ftp
327	mkdir -p ftp
328	cp *.txz MANIFEST ftp
329
330release:
331	${MAKE} -C ${.CURDIR} ${.MAKEFLAGS} obj
332	${MAKE} -C ${.CURDIR} ${.MAKEFLAGS} ${RELEASE_TARGETS}
333.if defined(WITH_VMIMAGES) && !empty(WITH_VMIMAGES)
334	${MAKE} -C ${.CURDIR} ${.MAKEFLAGS} ${VMTARGETS}
335.endif
336
337install:
338.if defined(DESTDIR) && !empty(DESTDIR)
339	mkdir -p ${DESTDIR}
340.endif
341	cp -a ftp ${DESTDIR}/
342.for I in ${IMAGES}
343	cp -p ${I} ${DESTDIR}/${OSRELEASE}-${I}
344. if defined(WITH_COMPRESSED_IMAGES) && !empty(WITH_COMPRESSED_IMAGES)
345	${XZCMD} -k ${DESTDIR}/${OSRELEASE}-${I}
346. endif
347.endfor
348	cd ${DESTDIR} && sha256 ${OSRELEASE}* > ${DESTDIR}/CHECKSUM.SHA256
349	cd ${DESTDIR} && md5 ${OSRELEASE}* > ${DESTDIR}/CHECKSUM.MD5
350.if defined(WITH_VMIMAGES) && !empty(WITH_VMIMAGES)
351	mkdir -p ${DESTDIR}/vmimages
352. for FORMAT in ${VMFORMATS}
353	cp -p ${VMBASE}.${FORMAT} \
354		${DESTDIR}/vmimages/${OSRELEASE}.${FORMAT}
355. endfor
356. if defined(WITH_COMPRESSED_VMIMAGES) && !empty(WITH_COMPRESSED_VMIMAGES)
357# This is very time consuming, so defer it after the images are moved to
358# the DESTDIR.
359.  for FORMAT in ${VMFORMATS}
360	# Don't keep the originals.  There is a copy in ${.OBJDIR} if needed.
361	${XZCMD} ${DESTDIR}/vmimages/${OSRELEASE}.${FORMAT}
362.  endfor
363. endif
364	cd ${DESTDIR}/vmimages && sha256 ${OSRELEASE}* > \
365		${DESTDIR}/vmimages/CHECKSUM.SHA256
366	cd ${DESTDIR}/vmimages && md5 ${OSRELEASE}* > \
367		${DESTDIR}/vmimages/CHECKSUM.MD5
368.endif
369
370vm-base:
371.if defined(WITH_VMIMAGES) && !empty(WITH_VMIMAGES)
372. if exists(${.CURDIR}/${TARGET}/mk-vmimage.sh)
373	env TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH} \
374		${.CURDIR}/${TARGET}/mk-vmimage.sh ${.TARGET} \
375		${VMBASE}.img ${WORLDDIR} ${.OBJDIR}/${.TARGET} ${VMSIZE}
376. endif
377.endif
378	touch ${.TARGET}
379
380vm-image: vm-base
381.if defined(WITH_VMIMAGES) && !empty(WITH_VMIMAGES)
382. if exists(${.CURDIR}/${TARGET}/mk-vmimage.sh)
383.  for FORMAT in ${VMFORMATS}
384	env TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH} \
385		${.CURDIR}/${TARGET}/mk-vmimage.sh ${.TARGET} \
386		${VMBASE}.img ${FORMAT} ${VMBASE}.${FORMAT}
387.  endfor
388. endif
389.endif
390	touch ${.TARGET}
391
392vm-azure:
393.if exists(${.CURDIR}/${TARGET}/mk-azure.sh)
394	env TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH} AZURECONF=${AZURECONF} \
395		${.CURDIR}/${TARGET}/mk-azure.sh ${.TARGET} azure.img \
396		${WORLDDIR} ${.TARGET} ${VMSIZE} ${OSRELEASE}.vhd
397.endif
398	touch ${.TARGET}
399