From 6e160e0acb7092678ffcb0010bbab00545fc875f Mon Sep 17 00:00:00 2001 From: Sascha Wildner Date: Tue, 1 Apr 2008 21:10:26 +0000 Subject: [PATCH] * MLINK nrelease(7) -> release(7). * Merge relevant information from nrelease/README. * Prerequisite for realquickrel is buildworld/-kernel and not necessarily make release (reported by Max Herrgaard ). --- nrelease/README | 59 ------------------------------- share/man/man7/Makefile | 3 +- share/man/man7/release.7 | 75 ++++++++++++++++++++++++++++++---------- 3 files changed, 58 insertions(+), 79 deletions(-) delete mode 100644 nrelease/README diff --git a/nrelease/README b/nrelease/README deleted file mode 100644 index 9d5de0358f..0000000000 --- a/nrelease/README +++ /dev/null @@ -1,59 +0,0 @@ -$DragonFly: src/nrelease/Attic/README,v 1.4 2008/03/25 22:55:38 dave Exp $ - -The DragonFly framework for building ISO image (nrelease) -========================================================= - -Important user-tunable variables --------------------------------- - -ISODIR default prefix of ISOFILE and ISOROOT -ISOFILE name of the ISO image to generate -ISOROOT location where to fresh world is installed to -KERNCONF kernel configuration to use - -PKGSRC_PACKAGES default list of packages to be added to the ISO -PKGSRC_PKG_ADD location of pkgsrc-style pkg_add used during build -PKGSRC_PKG_PATH location of binary packages to be added to the ISO -PKGSRC_BOOTSTRAP_FILE location of the bootstrap kit - (this must be local, PKGSRC_PKG_PATH can be remote) -PKGSRC_DB db location used by the bootstrap kit -PKGSRC_PREFIX localbase used by the bootstrap kit -PKGSRC_RSYNC_SRC where to fetch packages from during make fetch - -WITH_INSTALLER if defined, the BSD installer is added to the target from pkgsrc -WITH_LOCAL_INSTALLER if defined, the BSD installer is added to the target from /usr/src - -The default values match the packages from packages.stura.uni-rostock.de. - - -Important targets ------------------ - -fetch fetches the bootstrap kit and binary packages using rsync -release builds world and kernel, installs them, adds packages and - prepares the ISO image -quickrel same as release, but use quickworld and quickkernel -realquickrel same as release, but skips buildworld and buildkernel - - -First time usage ----------------- - -The nrelease framework expects to find a working pkg_add from pkgsrc. -You can use the bootstrap kit, which matches the default configuration, -or install it yourself. If you use a location other than /usr/pkg, you -have to specify PKGSRC_PKG_ADD in make.conf. - -If you want to have any packages install in the ISO (the default), run -``make fetch'' first, to get them and the bootstrap kit used in the ISO. -By default, the current directory is used, the location can and should -be overridden by PKGSRC_PKG_PATH in make.conf. - -RELEASE ENGINEERING --------------------------------- - -The steps required for engineering a release are documented in (CVS) -doc/notes/release.txt. How to branch the CVS tree, etc. They were put -in an out of the way place so normal developers would not accidently try -to run the commands in question. - diff --git a/share/man/man7/Makefile b/share/man/man7/Makefile index 4092660451..9ac2738ffa 100644 --- a/share/man/man7/Makefile +++ b/share/man/man7/Makefile @@ -1,6 +1,6 @@ # @(#)Makefile 8.1 (Berkeley) 6/5/93 # $FreeBSD: src/share/man/man7/Makefile,v 1.10.2.7 2002/12/28 19:09:50 dillon Exp $ -# $DragonFly: src/share/man/man7/Makefile,v 1.12 2007/12/21 22:14:04 swildner Exp $ +# $DragonFly: src/share/man/man7/Makefile,v 1.13 2008/04/01 21:10:26 swildner Exp $ #MISSING: eqnchar.7 ms.7 term.7 MAN= ascii.7 \ @@ -24,6 +24,7 @@ MAN= ascii.7 \ vkernel.7 MLINKS= intro.7 miscellaneous.7 +MLINKS+=release.7 nrelease.7 MLINKS+=vkernel.7 vcd.4 \ vkernel.7 vkd.4 \ vkernel.7 vke.4 diff --git a/share/man/man7/release.7 b/share/man/man7/release.7 index 6d9ead7d79..bdc63b0faf 100644 --- a/share/man/man7/release.7 +++ b/share/man/man7/release.7 @@ -29,14 +29,14 @@ .\" SUCH DAMAGE. .\" .\" $FreeBSD: src/share/man/man7/release.7,v 1.3.2.6 2003/04/12 20:42:30 murray Exp $ -.\" $DragonFly: src/share/man/man7/release.7,v 1.11 2008/03/08 22:00:03 swildner Exp $ +.\" $DragonFly: src/share/man/man7/release.7,v 1.12 2008/04/01 21:10:26 swildner Exp $ .\" -.Dd March 8, 2008 -.Dt RELEASE 7 +.Dd April 1, 2008 +.Dt NRELEASE 7 .Os .Sh NAME -.Nm release -.Nd "release building infrastructure" +.Nm nrelease +.Nd release building infrastructure .Sh DESCRIPTION .Dx provides a complete build environment suitable for users to make @@ -60,7 +60,8 @@ defines a number of targets which are roughly modeled after the targets used for building the system. .Bl -tag -width ".Cm realquickrel" .It Cm release -Builds a vanilla live CD. +Builds world and kernel, installs them, adds packages and prepares the ISO +image. .It Cm quickrel Same as .Cm release @@ -81,6 +82,9 @@ Removes the ISO root directory and object files. Same as .Cm clean but also removes external packages. +.It Cm fetch +Downloads the bootstrap kit and binary packages using +.Xr fetch 1 . .El .Pp The @@ -88,8 +92,10 @@ The and .Cm realquickrel targets will only work if a full -.Dq Li "make release" -has been done before. +.Cm buildworld +and +.Cm buildkernel +have been done before. For a description of the corresponding build targets, see .Xr build 7 . .Pp @@ -113,14 +119,42 @@ your system. If they cannot be found, the release process will stop and give proper commands for downloading and setting up these packages. .Sh ENVIRONMENT -.Bl -tag -width ".Va PKGSRC_PKG_PATH" +.Bl -tag -width ".Va PKGBIN_PKG_DELETE" +.It Va ISODIR +Default prefix of +.Va ISOFILE +and +.Va ISOROOT . +.It Va ISOFILE +Name of the ISO image to generate. +.It Va ISOROOT +Location where the image contents are installed to before the ISO is prepared. +.It Va KERNCONF +Kernel configuration(s) to use. +.It Va PKGBIN_MKISOFS +Location of the +.Xr mkisofs 8 +utility which is to be used during the build. +.It Va PKGBIN_PKG_ADD +Location of the +.Xr pkg_add 1 +utility which is to be used during the build. +.It Va PKGBIN_PKG_ADMIN +Location of the +.Xr pkg_admin 1 +utility which is to be used during the build. +.It Va PKGBIN_PKG_DELETE +Location of the +.Xr pkg_delete 1 +utility which is to be used during the build. +.It Va PKGSRC_PACKAGES +List of packages to be added to the ISO. .It Va PKGSRC_PKG_PATH Specifies the location where binary .Xr pkgsrc 7 packages are kept. .It Va WITHOUT_SRCS -If set, this variable will prevent kernel source code from being copied -to +If set, this variable will prevent kernel source code from being copied to .Pa /usr/src-sys.tar.bz2 on the ISO image. .El @@ -133,12 +167,12 @@ on the ISO image. .El .Sh EXAMPLES The following sequence of commands is used to build a standard -.Dx 1.10 +.Dx 1.12 installation CD image (assuming that a local CVS repository is available): .Bd -literal -offset indent cd /usr -cvs co -rDragonFly_RELEASE_1_10_Slip src +cvs co -rDragonFly_RELEASE_1_12_Slip src cd src/nrelease make installer release .Ed @@ -146,6 +180,12 @@ make installer release After running these commands, the image will be available in the .Pa /usr/release directory. +.Pp +The steps required for engineering a release are documented in (CVS) +.Pa doc/notes/release.txt +(how to branch the CVS tree etc.) +They were put in an out of the way place so normal developers would not +accidentally try to run the commands in question. .Sh SEE ALSO .Xr cvs 1 , .Xr make 1 , @@ -153,8 +193,9 @@ directory. .Xr build 7 , .Xr pkgsrc 7 .Sh HISTORY -.Pa src/nrelease -was added in +The +.Nm +framework was added in .Dx 1.0 to implement the idea of a .Dq "live CD" . @@ -166,7 +207,3 @@ infrastructure was written by .An Matthew Dillon . This manual page was written by .An Sascha Wildner . -.Sh BUGS -There are more targets and variables in -.Pa src/nrelease/Makefile -that should be documented. -- 2.41.0