releng: fix rendering of replaceable variables

Add 'subs="attributes"' to [source] and [.programlisting] blocks
to properly replace variables in rendered output.

Sponsored by:	Rubicon Communications, LLC ("Netgate")
This commit is contained in:
Glen Barber 2021-02-01 16:15:09 -05:00
parent fabd1efd2c
commit 790a769f67

View file

@ -346,7 +346,7 @@ See <<releng-building>> for information on building the `ALPHA` images.
When creating the {branchStable} branch, several changes are required in both the new {branchStable} branch and the {branchHead} branch. The files listed are relative to the repository root. To create the new {branchStablex} branch in Subversion:
[source,bash]
[source,bash,subs="attributes"]
....
% svn cp ^/head {branchStablex}
....
@ -365,7 +365,7 @@ Once the {branchStablex} branch has been committed, make the following edits:
|[.filename]#stable/12/contrib/jemalloc/include/jemalloc/jemalloc_FreeBSD.h#
a|
[source,bash]
[source,bash,subs="attributes"]
....
#ifndef MALLOC_PRODUCTION
#define MALLOC_PRODUCTION
@ -484,7 +484,7 @@ In the `doc` repository, also update [.filename]#head/en_US.ISO8859-1/htdocs/rel
Following the code slush, the next phase of the release cycle is the code freeze. This is the point at which all commits to the stable branch require explicit approval from the {teamRe}. This is enforced by pre-commit hooks in the Subversion repository by editing [.filename]#base/svnadmin/conf/approvers# to include a regular expression matching the {branchStablex} branch for the release:
[.programlisting]
[.programlisting,subs="attributes"]
....
^/{branchStablex} re
^/{branchRelengx} re
@ -504,7 +504,7 @@ Once this is done, the first set of `BETA` builds are started. Subsequent `BETA`
When the first `RC` (Release Candidate) build is ready to begin, the {branchReleng} branch is created. This is a multi-step process that must be done in a specific order, in order to avoid anomalies such as overlaps with `__FreeBSD_version` values, for example. The paths listed below are relative to the repository root. The order of commits and what to change are:
[source,bash]
[source,bash,subs="attributes"]
....
% svn cp ^/{branchStablex} {branchRelengx}
....
@ -537,7 +537,7 @@ When the first `RC` (Release Candidate) build is ready to begin, the {branchRele
|Add a new approvers line for the releng branch as was done for the stable branch
|===
[source,bash]
[source,bash,subs="attributes"]
....
% svn propdel -R svn:mergeinfo {branchRelengx}
% svn commit {branchRelengx}
@ -569,14 +569,14 @@ Prior to FreeBSD 9.2-RELEASE, [.filename]#src/release/release.sh# was introduced
As a brief example of using [.filename]#src/release/release.sh# to build a single release in [.filename]#/scratch#:
[source,bash]
[source,bash,subs="attributes"]
....
# /bin/sh /usr/src/release/release.sh
....
As a brief example of using [.filename]#src/release/release.sh# to build a single, cross-built release using a different target directory, create a custom [.filename]#release.conf# containing:
[.programlisting]
[.programlisting,subs="attributes"]
....
# release.sh configuration for powerpc/powerpc64
CHROOTDIR="/scratch-powerpc64"
@ -587,7 +587,7 @@ KERNEL="GENERIC64"
Then invoke [.filename]#src/release/release.sh# as:
[source,bash]
[source,bash,subs="attributes"]
....
# /bin/sh /usr/src/release/release.sh -c $HOME/release.conf
....
@ -641,7 +641,7 @@ As [.filename]#thermite.sh# iterates through the master list of combinations and
Assuming these filesystem paths, [.filename]#thermite.sh# would be invoked as:
[source,bash]
[source,bash,subs="attributes"]
....
# cd /releng/scripts-snapshot/scripts
# ./setrev.sh -b {branchStablex}
@ -651,7 +651,7 @@ Assuming these filesystem paths, [.filename]#thermite.sh# would be invoked as:
Once the builds have completed, additional helper scripts are available to generate development snapshot emails which are sent to the `freebsd-snapshots@freebsd.org` mailing list:
[source,bash]
[source,bash,subs="attributes"]
....
# cd /releng/scripts-snapshot/scripts
# ./get-checksums.sh -c ./builds-12.conf | ./generate-email.pl > snapshot-12-mail
@ -698,7 +698,7 @@ In preparation for the release build, several files need to be updated:
After building the final `RELEASE`, the {branchRelengx} branch is tagged as {branchReleasex} using the revision from which the `RELEASE` was built. Similar to creating the {branchStablex} and {branchRelengx} branches, this is done with `svn cp`. From the repository root:
[source,bash]
[source,bash,subs="attributes"]
....
% svn cp ^/{branchRelengx}@r306420 {branchReleasex}
% svn commit {branchReleasex}
@ -718,7 +718,7 @@ Staging FreeBSD snapshots and releases is a two part process:
+
If `EVERYTHINGISFINE` is defined in the build configuration files, [.filename]#main.conf# in the case of the build scripts referenced above, this happens automatically in the after the build is complete, creating the directory structure in [.filename]#${DESTDIR}/R/ftp-stage# with a path structure matching what is expected on `ftp-master`. This is equivalent to running the following in the directly:
+
[source,bash]
[source,bash,subs="attributes"]
....
# make -C /usr/src/release -f Makefile.mirrors EVERYTHINGISFINE=1 ftp-stage
....
@ -752,7 +752,7 @@ As with the staging steps, this requires `root` level access, as this step must
As the `archive` user:
[source,bash]
[source,bash,subs="attributes"]
....
% cd /archive/tmp/snapshots
% pax -r -w -l . /archive/pub/FreeBSD/snapshots