Add the contents of portbuild/tools/example_install as an example of

how to quickly install portbuild.
This commit is contained in:
Mark Linimon 2013-02-13 02:56:35 +00:00
parent fd56ccabd5
commit e5538029cb
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=40961

View file

@ -2462,9 +2462,6 @@ zfs destroy -r a/snap/src-<replaceable>old-branch</replaceable></screen>
jails.</para>
</listitem>
</itemizedlist>
<para>This document has not yet been updated with the latest changes.
</para>
</sect2>
<sect2 id="pointyhat-basics">
@ -2481,12 +2478,6 @@ zfs destroy -r a/snap/src-<replaceable>old-branch</replaceable></screen>
<literal>'*'</literal> password.</para>
</step>
<step>
<para>Export that value for a later initialization step:</para>
<screen>&prompt.root; export PORTBUILD_USER=<replaceable>portbuild</replaceable></screen>
</step>
<step>
<para>Similarly, create a user to own the administration functions
and manage the <application>svn</application>
@ -2494,12 +2485,6 @@ zfs destroy -r a/snap/src-<replaceable>old-branch</replaceable></screen>
<literal>'*'</literal> password.</para>
</step>
<step>
<para>Export that value for a later initialization step:</para>
<screen>&prompt.root; export SRCBUILD_USER=<replaceable>srcbuild</replaceable></screen>
</step>
<step>
<para>Add the following to <filename>/boot/loader.conf</filename>:</para>
@ -2644,7 +2629,56 @@ sysutils/zfs-stats</programlisting>
<para>The following steps need to be done as euid root.</para>
<para>Here is a quick example:</para>
<example>
<title>The contents of example file <filename>portbuild/tools/example_install</filename></title>
<screen>
#!/bin/sh
#
# example script to drive the "mkportbuild" kickstart file
#
export PORTBUILD_USER=portbuild
export SRCBUILD_USER=srcbuild
export ZFS_VOLUME=a
export ZFS_MOUNTPOINT=/a
export VCS_REPOSITORY=svn://svn0.us-east.FreeBSD.org
#
# create the zpool. the examples here are just suggestions and need to be
# customized for your site.
#
# simple examples:
# zpool create ${ZFS_VOLUME} da1
# zpool create ${ZFS_VOLUME} gprootfs
# more complex example:
# zpool create ${ZFS_VOLUME} mirror da1 da2 mirror da3 da4 mirror da5 da6 mirror da7 da8
#
# check out the kickstart file and run it
#
mkdir -p tmp
svn checkout ${VCS_REPOSITORY}/base/projects/portbuild/admin/tools tmp
sh -x ./tmp/mkportbuild
</screen>
</example>
<para>Here is a detailed explanation of the example:</para>
<procedure>
<step>
<para>Export the value of <makevar>PORTBUILD_USER</makevar>:</para>
<screen>&prompt.root; export PORTBUILD_USER=<replaceable>portbuild</replaceable></screen>
</step>
<step>
<para>Export the value of <makevar>SRCBUILD_USER</makevar>:</para>
<screen>&prompt.root; export SRCBUILD_USER=<replaceable>srcbuild</replaceable></screen>
</step>
<step>
<para>Pick a <application>zfs</application> volume name and export
it. We have used <replaceable>a</replaceable> so far to date.</para>
@ -2670,9 +2704,11 @@ sysutils/zfs-stats</programlisting>
</example>
<note>
<para>We will define a <application>zfs</application>
<literal>permission set</literal> below, so that the
<replaceable>srcbuild</replaceable> user may administer this
<para>The kickstart script defines <application>zfs</application>
<literal>permission sets</literal>, so that the
<replaceable>srcbuild</replaceable> user and
<replaceable>portbuild</replaceable> user may administer
subdirectories of this
volume without having to have root privileges.</para>
</note>
</step>
@ -2890,7 +2926,7 @@ sysutils/zfs-stats</programlisting>
<procedure>
<step>
<para>Copy the following files from
<para>As <literal>root</literal>, copy the following files from
<filename>/a/portbuild/admin/etc/rc.d/</filename> to
<filename>/usr/local/etc/rc.d/</filename>:</para>