release: permanently remove the 'reldoc' target and associates

Following 7b1d1a1658, the structure for the reldoc target has significantly changed as result of the ASCIIDoctor/Hugo migration. As the release notes related files on the installation medium are inherently out of date, purge them entirely. Discussed within: re, doceng No objection: re (silence), doceng (silence) Timeout: 2 weeks Sponsored by: Rubicon Communications, LLC ("Netgate") (cherry picked from commit f61e92ca5a)
2021-02-17 23:00:03 -05:00 · 2021-02-17 23:00:03 -05:00 · 716f5ae59a
commit 716f5ae59a
parent 82c84b8501
12 changed files with 6 additions and 107 deletions
--- a/release/Makefile
+++ b/release/Makefile
@ -20,12 +20,10 @@
 #  WORLDDIR: location of src tree -- must have built world and default kernel
 #            (by default, the directory above this one)
 #  PORTSDIR: location of ports tree to distribute (default: /usr/ports)
-#  DOCDIR:   location of doc tree (default: /usr/doc)
 #  XTRADIR:  xtra-bits-dir argument for <arch>/mkisoimages.sh
 #  NOPKG:    if set, do not distribute third-party packages
 #  NOPORTS:  if set, do not distribute ports tree
 #  NOSRC:    if set, do not distribute source tree
-#  NODOC:    if set, do not generate release documentation
 #  WITH_DVD: if set, generate dvd1.iso
 #  WITH_COMPRESSED_IMAGES: if set, compress installation images with xz(1)
 #		(uncompressed images are not removed)
@ -38,7 +36,6 @@

 WORLDDIR?=	${.CURDIR}/..
 PORTSDIR?=	/usr/ports
-DOCDIR?=	/usr/doc
 RELNOTES_LANG?= en_US.ISO8859-1

 .if !defined(TARGET) || empty(TARGET)
@ -74,9 +71,6 @@ VOLUME_LABEL=	${REVISION:C/[.-]/_/g}_${BRANCH:C/[.-]/_/g}_${TARGET_ARCH}
 VOLUME_LABEL=	FreeBSD_Install
 .endif

-.if !exists(${DOCDIR})
-NODOC= true
-.endif
 .if !exists(${PORTSDIR})
 NOPORTS= true
 .endif
@ -88,9 +82,6 @@ EXTRA_PACKAGES+= ports.txz
 .if !defined(NOSRC)
 EXTRA_PACKAGES+= src.txz
 .endif
-#.if !defined(NODOC)
-#EXTRA_PACKAGES+= reldoc
-#.endif

 RELEASE_TARGETS= ftp
 IMAGES=
@ -119,9 +110,6 @@ CLEANFILES+=	${I}.xz
 CLEANFILES+=	pkg-stage
 .endif
 CLEANDIRS=	dist ftp disc1 bootonly dvd
-#.if !defined(NODOC)
-#CLEANDIRS+=    reldoc rdoc
-#.endif
 beforeclean:
 	chflags -R noschg .
 .include <bsd.obj.mk>
@ -161,23 +149,6 @@ ports.txz:
 	    --exclude 'usr/ports/INDEX*' --exclude work usr/ports | \
 	    ${XZ_CMD} > ${.OBJDIR}/ports.txz

-#reldoc:
-#	cd ${DOCDIR}/en_US.ISO8859-1/htdocs/releases/${REVISION}R && \
-#	    env MAN4DIR=${WORLDDIR}/share/man/man4 \
-#	    _BRANCH=${BRANCH} \
-#	    ${MAKE} all install clean "FORMATS=html txt" \
-#	    INSTALL_COMPRESSED='' URLS_ABSOLUTE=YES DOCDIR=${.OBJDIR}/rdoc \
-#	    WEBDIR=${DOCDIR} DESTDIR=${.OBJDIR}/rdoc
-#	mkdir -p reldoc
-#.for i in hardware readme relnotes errata
-#	ln -f ${.OBJDIR}/rdoc/${i:tl}.txt \
-#		reldoc/${i:tu}.TXT
-#	ln -f ${.OBJDIR}/rdoc/${i:tl}.html \
-#		reldoc/${i:tu}.HTML
-#.endfor
-#	cp ${.OBJDIR}/rdoc/docbook.css \
-#		reldoc/
-
 disc1: packagesystem
 # Install system
 	mkdir -p ${.TARGET}
@ -193,10 +164,6 @@ disc1: packagesystem
 	for dist in MANIFEST $$(ls *.txz | grep -vE -- '(base|lib32)-dbg'); \
 	    do cp $${dist} ${.TARGET}/usr/freebsd-dist; \
 	done
-# Copy documentation, if generated
-#.if !defined(NODOC)
-#	cp reldoc/* ${.TARGET}
-#.endif
 # Set up installation environment
 	ln -fs /tmp/bsdinstall_etc/resolv.conf ${.TARGET}/etc/resolv.conf
 	echo sendmail_enable=\"NONE\" > ${.TARGET}/etc/rc.conf
@ -220,10 +187,6 @@ bootonly: packagesystem
 # Copy manifest only (no distfiles) to get checksums
 	mkdir -p ${.TARGET}/usr/freebsd-dist
 	cp MANIFEST ${.TARGET}/usr/freebsd-dist
-# Copy documentation, if generated
-#.if !defined(NODOC)
-#	cp reldoc/* ${.TARGET}
-#.endif
 # Set up installation environment
 	ln -fs /tmp/bsdinstall_etc/resolv.conf ${.TARGET}/etc/resolv.conf
 	echo sendmail_enable=\"NONE\" > ${.TARGET}/etc/rc.conf
@ -244,10 +207,6 @@ dvd: packagesystem
 	for dist in MANIFEST $$(ls *.txz | grep -v -- '(base|lib32)-dbg'); \
 	    do cp $${dist} ${.TARGET}/usr/freebsd-dist; \
 	done
-# Copy documentation, if generated
-#.if !defined(NODOC)
-#	cp reldoc/* ${.TARGET}
-#.endif
 # Set up installation environment
 	ln -fs /tmp/bsdinstall_etc/resolv.conf ${.TARGET}/etc/resolv.conf
 	echo sendmail_enable=\"NONE\" > ${.TARGET}/etc/rc.conf
--- a/release/arm/GENERICSD.conf
+++ b/release/arm/GENERICSD.conf
@ -12,7 +12,6 @@ FAT_TYPE="16"
 IMAGE_SIZE="3072M"
 KERNEL="GENERIC"
 MD_ARGS="-x 63 -y 255"
-NODOC=1
 BBB_UBOOT_DIR="/usr/local/share/u-boot/u-boot-beaglebone"
 RPI_UBOOT_DIR="/usr/local/share/u-boot/u-boot-rpi2"
 RPI_FIRMWARE_DIR="/usr/local/share/rpi-firmware"
--- a/release/arm/RPI-B.conf
+++ b/release/arm/RPI-B.conf
@ -12,7 +12,6 @@ FAT_TYPE="16"
 IMAGE_SIZE="3072M"
 KERNEL="RPI-B"
 MD_ARGS="-x 63 -y 255"
-NODOC=1
 UBOOT_DIR="/usr/local/share/u-boot/u-boot-rpi"
 RPI_FIRMWARE_DIR="/usr/local/share/rpi-firmware"
 OL_DIR="${RPI_FIRMWARE_DIR}/overlays"
--- a/release/arm64/PINE64-LTS.conf
+++ b/release/arm64/PINE64-LTS.conf
@ -12,7 +12,6 @@ FAT_TYPE="16"
 IMAGE_SIZE="3072M"
 KERNEL="GENERIC"
 MD_ARGS="-x 63 -y 255"
-NODOC=1
 PART_SCHEME="GPT"
 FDT_OVERLAYS="sun50i-a64-timer,sun50i-a64-opp"
 export BOARDNAME="PINE64-LTS"
--- a/release/arm64/PINE64.conf
+++ b/release/arm64/PINE64.conf
@ -12,7 +12,6 @@ FAT_TYPE="16"
 IMAGE_SIZE="3072M"
 KERNEL="GENERIC"
 MD_ARGS="-x 63 -y 255"
-NODOC=1
 PART_SCHEME="GPT"
 FDT_OVERLAYS="sun50i-a64-timer,sun50i-a64-opp"
 export BOARDNAME="PINE64"
--- a/release/arm64/PINEBOOK.conf
+++ b/release/arm64/PINEBOOK.conf
@ -12,7 +12,6 @@ FAT_TYPE="16"
 IMAGE_SIZE="3072M"
 KERNEL="GENERIC"
 MD_ARGS="-x 63 -y 255"
-NODOC=1
 PART_SCHEME="GPT"
 FDT_OVERLAYS="sun50i-a64-timer,sun50i-a64-opp"
 export BOARDNAME="PINEBOOK"
--- a/release/arm64/ROCK64.conf
+++ b/release/arm64/ROCK64.conf
@ -12,7 +12,6 @@ FAT_TYPE="16"
 IMAGE_SIZE="3072M"
 KERNEL="GENERIC"
 MD_ARGS="-x 63 -y 255"
-NODOC=1
 PART_SCHEME="GPT"
 export BOARDNAME="ROCK64"

--- a/release/arm64/ROCKPRO64.conf
+++ b/release/arm64/ROCKPRO64.conf
@ -12,7 +12,6 @@ FAT_TYPE="16"
 IMAGE_SIZE="3072M"
 KERNEL="GENERIC"
 MD_ARGS="-x 63 -y 255"
-NODOC=1
 PART_SCHEME="GPT"
 export BOARDNAME="ROCKPRO64"

--- a/release/arm64/RPI.conf
+++ b/release/arm64/RPI.conf
@ -14,7 +14,6 @@ FAT_TYPE="16"
 IMAGE_SIZE="3072M"
 KERNEL="GENERIC"
 MD_ARGS="-x 63 -y 255"
-NODOC=1
 OL_DIR="${DTB_DIR}/overlays"
 OVERLAYS="mmc.dtbo pwm.dtbo disable-bt.dtbo"
 PART_SCHEME="MBR"
--- a/release/release.conf.sample
+++ b/release/release.conf.sample
@ -16,11 +16,9 @@ CHROOTDIR="/scratch"
 GITROOT="https://git.freebsd.org/"
 GITSRC="src.git"
 GITPORTS="ports.git"
-GITDOC="doc.git"

 ## Set the src/, ports/, and doc/ branches or tags.
 SRCBRANCH="stable/13"
-DOCBRANCH="main"
 PORTBRANCH="main"

 ## Sample configuration for using git from ports.
@ -45,7 +43,6 @@ PORTBRANCH="main"
 #KERNEL_FLAGS="-j $(( $(( $(sysctl -n hw.ncpu) + 1 )) / 2 ))"

 ## Set miscellaneous 'make release' settings.
-#NODOC=
 #NOPORTS=
 #NOSRC=
 #WITH_DVD=
@ -80,10 +77,6 @@ PORTBRANCH="main"
 ## the chroot.  This is intended for use when /usr/src already exists.
 #SRC_UPDATE_SKIP=

-## Set to a non-empty value skip checkout or update of /usr/doc in
-## the chroot.  This is intended for use when /usr/doc already exists.
-#DOC_UPDATE_SKIP=
-
 ## Set to a non-empty value skip checkout or update of /usr/ports in
 ## the chroot.  This is intended for use when /usr/ports already exists.
 #PORTS_UPDATE_SKIP=
--- a/release/release.sh
+++ b/release/release.sh
@ -86,11 +86,9 @@ env_setup() {
 	# and ports/.
 	GITROOT="https://git.FreeBSD.org/"
 	SRCBRANCH="main"
-	DOCBRANCH="main"
 	PORTBRANCH="head"
 	GITSRC="src.git"
 	GITPORTS="ports.git"
-	GITDOC="doc.git"

 	# Set for embedded device builds.
 	EMBEDDEDBUILD=
@ -112,8 +110,6 @@ env_setup() {
 	KERNEL="GENERIC"

 	# Set to non-empty value to disable checkout of doc/ and/or ports/.
-	# Disabling ports/ checkout also forces NODOC to be set.
-	NODOC=
 	NOPORTS=

 	# Set to non-empty value to disable distributing source tree.
@ -145,14 +141,12 @@ env_check() {

 	# Prefix the branches with the GITROOT for the full checkout URL.
 	SRC="${GITROOT}${GITSRC}"
-	DOC="${GITROOT}${GITDOC}"
 	#PORT="${GITROOT}${GITPORTS}"
 	PORT="svn://svn.freebsd.org/ports/"

 	if [ -n "${EMBEDDEDBUILD}" ]; then
 		WITH_DVD=
 		WITH_COMPRESSED_IMAGES=
-		NODOC=yes
 		case ${EMBEDDED_TARGET}:${EMBEDDED_TARGET_ARCH} in
 			arm:arm*|arm64:aarch64|riscv:riscv64*)
 				chroot_build_release_cmd="chroot_arm_build_release"
@ -162,26 +156,15 @@ env_check() {
 		esac
 	fi

-	# If PORTS is set and NODOC is unset, force NODOC=yes because the ports
-	# tree is required to build the documentation set.
-	if [ -n "${NOPORTS}" ] && [ -z "${NODOC}" ]; then
-		echo "*** NOTICE: Setting NODOC=1 since ports tree is required"
-		echo "            and NOPORTS is set."
-		NODOC=yes
-	fi
-
-	# If NOSRC, NOPORTS and/or NODOC are unset, they must not pass to make
+	# If NOSRC and/or NOPORTS are unset, they must not pass to make
 	# as variables.  The release makefile verifies definedness of the
-	# NOPORTS/NODOC variables instead of their values.
-	SRCDOCPORTS=
+	# NOPORTS variable instead of its value.
+	SRCPORTS=
 	if [ -n "${NOPORTS}" ]; then
-		SRCDOCPORTS="NOPORTS=yes"
-	fi
-	if [ -n "${NODOC}" ]; then
-		SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NODOC=yes"
+		SRCPORTS="NOPORTS=yes"
 	fi
 	if [ -n "${NOSRC}" ]; then
-		SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NOSRC=yes"
+		SRCPORTS="${SRCPORTS}${SRCPORTS:+ }NOSRC=yes"
 	fi

 	# The aggregated build-time flags based upon variables defined within
@ -220,7 +203,7 @@ env_check() {
 	RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} \
 		KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
 	RELEASE_RMAKEFLAGS="${ARCH_FLAGS} \
-		KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCDOCPORTS} \
+		KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCPORTS} \
 		WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
 		WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}"

@ -239,13 +222,6 @@ chroot_setup() {
 			${VCSCMD} ${SRC} -b ${SRCBRANCH} ${CHROOTDIR}/usr/src
 		fi
 	fi
-	if [ -z "${NODOC}" ] && [ -z "${DOC_UPDATE_SKIP}" ]; then
-		if [ -d "${CHROOTDIR}/usr/doc/.git" ]; then
-			git -C ${CHROOTDIR}/usr/doc pull -q
-		else
-			${VCSCMD} ${DOC} -b ${DOCBRANCH} ${CHROOTDIR}/usr/doc
-		fi
-	fi
 	if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
 		# if [ -d "${CHROOTDIR}/usr/ports/.git" ]; then
 			# git -C ${CHROOTDIR}/usr/ports pull -q
@ -327,26 +303,6 @@ extra_chroot_setup() {
 				pkg clean -y
 		fi
 	fi
-	if [ -z "${NODOC}" ] && [ -d ${CHROOTDIR}/usr/ports ]; then
-		# Trick the ports 'run-autotools-fixup' target to do the right
-		# thing.
-		_OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
-		REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
-		BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
-		UNAME_r=${REVISION}-${BRANCH}
-		if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then
-			PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
-			PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
-			PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
-			PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
-			PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
-			chroot ${CHROOTDIR} env ${PBUILD_FLAGS} \
-				OPTIONS_UNSET="AVAHI FOP IGOR" make -C \
-				/usr/ports/textproc/docproj \
-				FORCE_PKG_REGISTER=1 \
-				install clean distclean
-		fi
-	fi

 	if [ ! -z "${EMBEDDEDPORTS}" ]; then
 		_OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
--- a/release/riscv/GENERICSD.conf
+++ b/release/riscv/GENERICSD.conf
@ -11,6 +11,5 @@ FAT_TYPE="16"
 IMAGE_SIZE="3072M"
 KERNEL="GENERIC"
 MD_ARGS="-x 63 -y 255"
-NODOC=1
 PART_SCHEME="GPT"
 export BOARDNAME="GENERICSD"