xref: /freebsd/release/Makefile (revision ec273ebf3b6aed5fba8c56b6ece5ad8693a48ea7) 
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: Invokes real-release, vm-release, and cloudware-release targets
12#  real-release: Build all media and FTP distribution area
13#  vm-release: Build all virtual machine image targets
14#  cloudware-release: Build all cloud hosting provider targets
15#  install: Invokes the release-install and vm-install targets
16#  release-install: Copies all release installation media into ${DESTDIR}
17#  vm-install: Copies all virtual machine images into ${DESTDIR}
18#
19# Variables affecting the build process:
20#  WORLDDIR: location of src tree -- must have built world and default kernel
21#            (by default, the directory above this one)
22#  PORTSDIR: location of ports tree to distribute (default: /usr/ports)
23#  DOCDIR:   location of doc tree (default: /usr/doc)
24#  NOPKG:    if set, do not distribute third-party packages
25#  NOPORTS:  if set, do not distribute ports tree
26#  NOSRC:    if set, do not distribute source tree
27#  NODOC:    if set, do not generate release documentation
28#  WITH_DVD: if set, generate dvd1.iso
29#  WITH_COMPRESSED_IMAGES: if set, compress installation images with xz(1)
30#		(uncompressed images are not removed)
31#  WITH_VMIMAGES: if set, build virtual machine images with the release
32#  WITH_COMPRESSED_VMIMAGES: if set, compress virtual machine disk images
33#  		with xz(1) (extremely time consuming)
34#  WITH_CLOUDWARE: if set, build cloud hosting disk images with the release
35#  TARGET/TARGET_ARCH: architecture of built release
36#  XZ_FLAGS: Additional arguments to pass to xz(1)
37#  XZ_THREADS: Number of xz(1) threads to use
38#  NO_XZTHREADS: Disable multi-threaded xz(1) compression
39#
40
41WORLDDIR?=	${.CURDIR}/..
42PORTSDIR?=	/usr/ports
43DOCDIR?=	/usr/doc
44RELNOTES_LANG?= en_US.ISO8859-1
45XZCMD?=		/usr/bin/xz
46XZ_FLAGS?=
47XZ_THREADS?=
48
49.if !defined(TARGET) || empty(TARGET)
50TARGET=		${MACHINE}
51.endif
52.if !defined(TARGET_ARCH) || empty(TARGET_ARCH)
53.if ${TARGET} == ${MACHINE}
54TARGET_ARCH=	${MACHINE_ARCH}
55.else
56TARGET_ARCH=	${TARGET}
57.endif
58.endif
59IMAKE=		${MAKE} TARGET_ARCH=${TARGET_ARCH} TARGET=${TARGET}
60DISTDIR=	dist
61
62.if !defined(NO_XZTHREADS) && empty(XZ_THREADS)
63XZ_THREADS=	0
64.else
65XZ_THREADS=	${XZ_THREADS}
66.endif
67.if !empty(XZ_THREADS)
68XZ_FLAGS+=	-T ${XZ_THREADS}
69.endif
70
71# Define OSRELEASE by using newvars.sh
72.if !defined(OSRELEASE) || empty(OSRELEASE)
73.for _V in TYPE BRANCH REVISION
74${_V}!=	eval $$(awk '/^${_V}=/{print}' ${.CURDIR}/../sys/conf/newvers.sh); echo $$${_V}
75.endfor
76.for _V in ${TARGET_ARCH}
77.if !empty(TARGET:M${_V})
78OSRELEASE=	${TYPE}-${REVISION}-${BRANCH}-${TARGET}
79VOLUME_LABEL=	${REVISION:C/[.-]/_/g}_${BRANCH:C/[.-]/_/g}_${TARGET}
80.else
81OSRELEASE=	${TYPE}-${REVISION}-${BRANCH}-${TARGET}-${TARGET_ARCH}
82VOLUME_LABEL=	${REVISION:C/[.-]/_/g}_${BRANCH:C/[.-]/_/g}_${TARGET_ARCH}
83.endif
84.endfor
85.endif
86
87.if !defined(VOLUME_LABEL) || empty(VOLUME_LABEL)
88VOLUME_LABEL=	FreeBSD_Install
89.endif
90
91.if !exists(${DOCDIR})
92NODOC= true
93.endif
94.if !exists(${PORTSDIR})
95NOPORTS= true
96.endif
97
98EXTRA_PACKAGES=
99.if !defined(NOPORTS)
100EXTRA_PACKAGES+= ports.txz
101.endif
102.if !defined(NOSRC)
103EXTRA_PACKAGES+= src.txz
104.endif
105.if !defined(NODOC)
106EXTRA_PACKAGES+= reldoc
107.endif
108
109RELEASE_TARGETS= ftp
110IMAGES=
111.if exists(${.CURDIR}/${TARGET}/mkisoimages.sh)
112RELEASE_TARGETS+= cdrom
113IMAGES+=	disc1.iso bootonly.iso
114. if defined(WITH_DVD) && !empty(WITH_DVD)
115RELEASE_TARGETS+= dvdrom
116IMAGES+=	dvd1.iso
117. endif
118.endif
119.if exists(${.CURDIR}/${TARGET}/make-memstick.sh)
120RELEASE_TARGETS+= memstick.img
121RELEASE_TARGETS+= mini-memstick.img
122IMAGES+=	memstick.img
123IMAGES+=	mini-memstick.img
124.endif
125
126CLEANFILES=	packagesystem *.txz MANIFEST release ${IMAGES}
127.if defined(WITH_COMPRESSED_IMAGES) && !empty(WITH_COMPRESSED_IMAGES)
128. for I in ${IMAGES}
129CLEANFILES+=	${I}.xz
130. endfor
131.endif
132.if defined(WITH_DVD) && !empty(WITH_DVD)
133CLEANFILES+=	pkg-stage
134.endif
135CLEANDIRS=	dist ftp disc1 bootonly dvd
136beforeclean:
137	chflags -R noschg .
138.include <bsd.obj.mk>
139clean: beforeclean
140
141base.txz:
142	mkdir -p ${DISTDIR}
143	cd ${WORLDDIR} && ${IMAKE} distributeworld DISTDIR=${.OBJDIR}/${DISTDIR}
144# Set up mergemaster root database
145	sh ${.CURDIR}/scripts/mm-mtree.sh -m ${WORLDDIR} -F \
146	    "TARGET_ARCH=${TARGET_ARCH} TARGET=${TARGET}" -D "${.OBJDIR}/${DISTDIR}/base"
147	etcupdate extract -B -M "TARGET_ARCH=${TARGET_ARCH} TARGET=${TARGET}" \
148	    -s ${WORLDDIR} -d "${.OBJDIR}/${DISTDIR}/base/var/db/etcupdate"
149# Package all components
150	cd ${WORLDDIR} && ${IMAKE} packageworld DISTDIR=${.OBJDIR}/${DISTDIR}
151	mv ${DISTDIR}/*.txz .
152
153kernel.txz:
154	mkdir -p ${DISTDIR}
155	cd ${WORLDDIR} && ${IMAKE} distributekernel packagekernel DISTDIR=${.OBJDIR}/${DISTDIR}
156	mv ${DISTDIR}/kernel*.txz .
157
158src.txz:
159	mkdir -p ${DISTDIR}/usr
160	ln -fs ${WORLDDIR} ${DISTDIR}/usr/src
161	cd ${DISTDIR} && tar cLvJf ${.OBJDIR}/src.txz --exclude .svn --exclude .zfs \
162	    --exclude .git --exclude @ --exclude usr/src/release/dist usr/src
163
164ports.txz:
165	mkdir -p ${DISTDIR}/usr
166	ln -fs ${PORTSDIR} ${DISTDIR}/usr/ports
167	cd ${DISTDIR} && tar cLvJf ${.OBJDIR}/ports.txz \
168	    --exclude .git --exclude .svn \
169	    --exclude usr/ports/distfiles --exclude usr/ports/packages \
170	    --exclude 'usr/ports/INDEX*' --exclude work usr/ports
171
172reldoc:
173	cd ${.CURDIR}/doc && ${MAKE} all install clean 'FORMATS=html txt' \
174	    INSTALL_COMPRESSED='' URLS_ABSOLUTE=YES DOCDIR=${.OBJDIR}/rdoc
175	mkdir -p reldoc
176.for i in hardware readme relnotes errata
177	ln -f rdoc/${RELNOTES_LANG}/${i}/article.txt reldoc/${i:tu}.TXT
178	ln -f rdoc/${RELNOTES_LANG}/${i}/article.html reldoc/${i:tu}.HTM
179.endfor
180	cp rdoc/${RELNOTES_LANG}/readme/docbook.css reldoc
181
182disc1: packagesystem
183# Install system
184	mkdir -p ${.TARGET}
185	cd ${WORLDDIR} && ${IMAKE} installkernel installworld distribution \
186		DESTDIR=${.OBJDIR}/${.TARGET} MK_RESCUE=no MK_KERNEL_SYMBOLS=no \
187		MK_PROFILE=no MK_SENDMAIL=no MK_TESTS=no MK_LIB32=no \
188		MK_DEBUG_FILES=no
189# Copy distfiles
190	mkdir -p ${.TARGET}/usr/freebsd-dist
191	for dist in MANIFEST $$(ls *.txz | grep -v -- '-dbg'); \
192	    do cp $${dist} ${.TARGET}/usr/freebsd-dist; \
193	done
194# Copy documentation, if generated
195.if !defined(NODOC)
196	cp reldoc/* ${.TARGET}
197.endif
198# Set up installation environment
199	ln -fs /tmp/bsdinstall_etc/resolv.conf ${.TARGET}/etc/resolv.conf
200	echo sendmail_enable=\"NONE\" > ${.TARGET}/etc/rc.conf
201	echo hostid_enable=\"NO\" >> ${.TARGET}/etc/rc.conf
202	echo debug.witness.trace=0 >> ${.TARGET}/etc/sysctl.conf
203	echo vfs.mountroot.timeout=\"10\" >> ${.TARGET}/boot/loader.conf
204	cp ${.CURDIR}/rc.local ${.TARGET}/etc
205	touch ${.TARGET}
206
207bootonly: packagesystem
208# Install system
209	mkdir -p ${.TARGET}
210	cd ${WORLDDIR} && ${IMAKE} installkernel installworld distribution \
211	    DESTDIR=${.OBJDIR}/${.TARGET} MK_AMD=no MK_AT=no \
212	    MK_GAMES=no MK_GROFF=no \
213	    MK_INSTALLLIB=no MK_LIB32=no MK_MAIL=no \
214	    MK_NCP=no MK_TOOLCHAIN=no MK_PROFILE=no \
215	    MK_INSTALLIB=no MK_RESCUE=no MK_DICT=no \
216	    MK_KERNEL_SYMBOLS=no MK_TESTS=no MK_DEBUG_FILES=no
217# Copy manifest only (no distfiles) to get checksums
218	mkdir -p ${.TARGET}/usr/freebsd-dist
219	cp MANIFEST ${.TARGET}/usr/freebsd-dist
220# Copy documentation, if generated
221.if !defined(NODOC)
222	cp reldoc/* ${.TARGET}
223.endif
224# Set up installation environment
225	ln -fs /tmp/bsdinstall_etc/resolv.conf ${.TARGET}/etc/resolv.conf
226	echo sendmail_enable=\"NONE\" > ${.TARGET}/etc/rc.conf
227	echo hostid_enable=\"NO\" >> ${.TARGET}/etc/rc.conf
228	echo debug.witness.trace=0 >> ${.TARGET}/etc/sysctl.conf
229	echo vfs.mountroot.timeout=\"10\" >> ${.TARGET}/boot/loader.conf
230	cp ${.CURDIR}/rc.local ${.TARGET}/etc
231
232dvd: packagesystem
233# Install system
234	mkdir -p ${.TARGET}
235	cd ${WORLDDIR} && ${IMAKE} installkernel installworld distribution \
236		DESTDIR=${.OBJDIR}/${.TARGET} MK_RESCUE=no MK_KERNEL_SYMBOLS=no \
237		MK_TESTS=no MK_DEBUG_FILES=no
238# Copy distfiles
239	mkdir -p ${.TARGET}/usr/freebsd-dist
240	for dist in MANIFEST $$(ls *.txz | grep -v -- '-dbg'); \
241	    do cp $${dist} ${.TARGET}/usr/freebsd-dist; \
242	done
243# Copy documentation, if generated
244.if !defined(NODOC)
245	cp reldoc/* ${.TARGET}
246.endif
247# Set up installation environment
248	ln -fs /tmp/bsdinstall_etc/resolv.conf ${.TARGET}/etc/resolv.conf
249	echo sendmail_enable=\"NONE\" > ${.TARGET}/etc/rc.conf
250	echo hostid_enable=\"NO\" >> ${.TARGET}/etc/rc.conf
251	echo debug.witness.trace=0 >> ${.TARGET}/etc/sysctl.conf
252	echo vfs.mountroot.timeout=\"10\" >> ${.TARGET}/boot/loader.conf
253	cp ${.CURDIR}/rc.local ${.TARGET}/etc
254	touch ${.TARGET}
255
256release.iso: disc1.iso
257disc1.iso: disc1
258	sh ${.CURDIR}/${TARGET}/mkisoimages.sh -b ${VOLUME_LABEL}_CD ${.TARGET} disc1
259
260dvd1.iso: dvd pkg-stage
261	sh ${.CURDIR}/${TARGET}/mkisoimages.sh -b ${VOLUME_LABEL}_DVD ${.TARGET} dvd
262
263bootonly.iso: bootonly
264	sh ${.CURDIR}/${TARGET}/mkisoimages.sh -b ${VOLUME_LABEL}_BO ${.TARGET} bootonly
265
266memstick: memstick.img
267memstick.img: disc1
268	sh ${.CURDIR}/${TARGET}/make-memstick.sh disc1 ${.TARGET}
269
270mini-memstick: mini-memstick.img
271mini-memstick.img: bootonly
272	sh ${.CURDIR}/${TARGET}/make-memstick.sh bootonly ${.TARGET}
273
274packagesystem: base.txz kernel.txz ${EXTRA_PACKAGES}
275	sh ${.CURDIR}/scripts/make-manifest.sh *.txz > MANIFEST
276	touch ${.TARGET}
277
278pkg-stage:
279.if !defined(NOPKG)
280	env REPOS_DIR=${.CURDIR}/pkg_repos/ \
281		sh ${.CURDIR}/scripts/pkg-stage.sh
282	mkdir -p ${.OBJDIR}/dvd/packages/repos/
283	cp ${.CURDIR}/scripts/FreeBSD_install_cdrom.conf \
284		${.OBJDIR}/dvd/packages/repos/
285.endif
286	touch ${.TARGET}
287
288cdrom: disc1.iso bootonly.iso
289dvdrom: dvd1.iso
290ftp: packagesystem
291	rm -rf ftp
292	mkdir -p ftp
293	cp *.txz MANIFEST ftp
294
295release:	real-release vm-release cloudware-release
296	touch ${.TARGET}
297
298real-release:
299	${MAKE} -C ${.CURDIR} ${.MAKEFLAGS} obj
300	${MAKE} -C ${.CURDIR} ${.MAKEFLAGS} ${RELEASE_TARGETS}
301
302install:	release-install vm-install
303
304release-install:
305.if defined(DESTDIR) && !empty(DESTDIR)
306	mkdir -p ${DESTDIR}
307.endif
308	cp -a ftp ${DESTDIR}/
309.for I in ${IMAGES}
310	cp -p ${I} ${DESTDIR}/${OSRELEASE}-${I}
311. if defined(WITH_COMPRESSED_IMAGES) && !empty(WITH_COMPRESSED_IMAGES)
312	${XZCMD} ${XZ_FLAGS} -k ${DESTDIR}/${OSRELEASE}-${I}
313. endif
314.endfor
315	cd ${DESTDIR} && sha256 ${OSRELEASE}* > ${DESTDIR}/CHECKSUM.SHA256
316	cd ${DESTDIR} && md5 ${OSRELEASE}* > ${DESTDIR}/CHECKSUM.MD5
317
318.include "${.CURDIR}/Makefile.vm"
319