diff --git a/documentation/content/en/books/porters-handbook/testing/_index.adoc b/documentation/content/en/books/porters-handbook/testing/_index.adoc --- a/documentation/content/en/books/porters-handbook/testing/_index.adoc +++ b/documentation/content/en/books/porters-handbook/testing/_index.adoc @@ -79,11 +79,13 @@ Do check the port with crossref:quick-porting[porting-portlint,`portlint`] before submitting or committing it. `portlint` warns about many common errors, both functional and stylistic. -For a new (or repocopied) port, `portlint -A` is the most thorough; for an existing port, `portlint -C` is sufficient. +For a new port, `portlint -A` is the most thorough; for an existing port, `portlint -C` is sufficient. Since `portlint` uses heuristics to try to figure out errors, it can produce false positive warnings. In addition, occasionally something that is flagged as a problem really cannot be done in any other way due to limitations in the ports framework. +pass:[] When in doubt, the best thing to do is ask on {freebsd-ports}. +pass:[] [[testing-porttools]] == Port Tools @@ -92,7 +94,8 @@ `port` is the front-end script, which can help simplify the testing job. Whenever a new port or an update to an existing one needs testing, use `port test` to test the port, including the <> checking. -This command also detects and lists any files that are not listed in [.filename]#pkg-plist#. For example: +This command also detects and lists any files that are not listed in [.filename]#pkg-plist#. +For example: [source,shell] .... @@ -139,7 +142,7 @@ * `stage-qa` checks for common problems like bad shebang, symlinks pointing outside the stage directory, setuid files, and non-stripped libraries... These tests will not find hard-coded paths inside the port's files, nor will it verify that `LOCALBASE` is being used to correctly refer to files from other ports. -The temporarily-installed port in [.filename]#/var/tmp/`make -V PORTNAME`# must be tested for proper operation to make sure there are no problems with paths. +The temporarily installed port in [.filename]#/var/tmp/`make -V PORTNAME`# must be tested for proper operation to make sure there are no problems with paths. `PREFIX` must not be set explicitly in a port's [.filename]#Makefile#. Users installing the port may have set `PREFIX` to a custom location, and the port must respect that setting. @@ -163,9 +166,9 @@ ==== [[testing-poudriere]] -== Poudriere +== poudriere -For a ports contributor, Poudriere is one of the most important and helpful testing and build tools. +For a ports contributor, poudriere is one of the most important and helpful testing and build tools. Its main features include: * Bulk building of the entire ports tree, specific subsets of the ports tree, or a single port including its dependencies @@ -175,15 +178,15 @@ * Testing of port builds before submitting a patch to the FreeBSD bug tracker or committing to the ports tree * Testing for successful ports builds using different options -Because Poudriere performs its building in a clean man:jail[8] environment and uses man:zfs[8] features, +Because poudriere performs its building in a clean man:jail[8] environment and uses man:zfs[8] features, it has several advantages over traditional testing on the host system: * No pollution of the host environment: No leftover files, no accidental removals, no changes of existing configuration files. * Verify [.filename]#pkg-plist# for missing or superfluous entries -* Ports committers sometimes ask for a Poudriere log alongside a patch submission to assess whether the patch is ready for integration into the ports tree +* Ports committers sometimes ask for a poudriere log alongside a patch submission to assess whether the patch is ready for integration into the ports tree It is also quite straightforward to set up and use, has no dependencies, and will run on any supported FreeBSD release. -This section shows how to install, configure, and run Poudriere as part of the normal workflow of a ports contributor. +This section shows how to install, configure, and run poudriere as part of the normal workflow of a ports contributor. The examples in this section show a default file layout, as standard in FreeBSD. Substitute any local changes accordingly. @@ -191,9 +194,9 @@ Both `${LOCALBASE}` and `${PREFIX}` are [.filename]#/usr/local# by default. [[testing-poudriere-installing]] -=== Installing Poudriere +=== Installing poudriere -Poudriere is available in the ports tree in package:ports-mgmt/poudriere[]. +poudriere is available in the ports tree in package:ports-mgmt/poudriere[]. It can be installed using man:pkg[8] or from ports: [source,shell] @@ -208,7 +211,7 @@ # make -C /usr/ports/ports-mgmt/poudriere install clean .... -There is also a work-in-progress version of Poudriere which will eventually become the next release. +There is also a work-in-progress version of poudriere which will eventually become the next release. It is available in package:ports-mgmt/poudriere-devel[]. This development version is used for the official FreeBSD package builds, so it is well tested. It often has newer interesting features. @@ -219,7 +222,7 @@ Those optimizations will not matter a lot when building ports on a desktop machine. [[testing-poudriere-setup]] -=== Setting Up Poudriere +=== Setting Up poudriere The port installs a default configuration file, [.filename]#/usr/local/etc/poudriere.conf#. Each parameter is documented in the configuration file and in man:poudriere[8]. @@ -228,31 +231,24 @@ [.programlisting] .... ZPOOL=tank -ZROOTFS=/poudriere BASEFS=/poudriere DISTFILES_CACHE=/usr/ports/distfiles RESOLV_CONF=/etc/resolv.conf -FREEBSD_HOST=ftp://ftp.freebsd.org -SVN_HOST=svn.FreeBSD.org .... `ZPOOL`:: -The name of the ZFS storage pool which Poudriere shall use. +The name of the ZFS storage pool which poudriere shall use. Must be listed in the output of `zpool status`. -`ZROOTFS`:: -The root of Poudriere-managed file systems. -This entry will cause Poudriere to create man:zfs[8] file systems under `tank/poudriere`. - `BASEFS`:: -The root mount point for Poudriere file systems. -This entry will cause Poudriere to mount `tank/poudriere` to `/poudriere`. +The root mount point for poudriere file systems. +This entry will cause poudriere to mount `tank/poudriere` to `/poudriere`. `DISTFILES_CACHE`:: Defines where distfiles are stored. -In this example, Poudriere and the host share the distfiles storage directory. +In this example, poudriere and the host share the distfiles storage directory. This avoids downloading tarballs which are already present on the system. -Please create this directory if it does not already exist so that Poudriere can find it. +Please create this directory if it does not already exist so that poudriere can find it. `RESOLV_CONF`:: Use the host [.filename]#/etc/resolv.conf# inside jails for DNS. @@ -260,19 +256,10 @@ It is not needed when using a proxy. Refer to the default configuration file for proxy configuration. -`FREEBSD_HOST`:: -The FTP/HTTP server to use when the jails are installed from FreeBSD releases and updated with man:freebsd-update[8]. -Choose a server location which is close, for example if the machine is located in Australia, use `ftp.au.freebsd.org`. - -`SVN_HOST`:: -The server from where jails are installed and updated when using Subversion. -Again, choose a nearby location. -A list of official Subversion mirrors can be found in the extref:{handbook}[FreeBSD Handbook Subversion section, svn-mirrors]. - [[testing-poudriere-create-jails]] -=== Creating Poudriere Jails +=== Creating poudriere Jails -Create the base jails which Poudriere will use for building: +Create the base jails which poudriere will use for building: [source,shell] .... @@ -289,21 +276,9 @@ .... Create `tank/poudriere/jails/12i386`, mount it on [.filename]#/poudriere/jails/12i386#, -then check out the tip of the Subversion branch of `FreeBSD-12-STABLE` from `SVN_HOST` in [.filename]#poudriere.conf# into [.filename]#/poudriere/jails/12i386/usr/src#, +then check out the tip of the Git branch of `FreeBSD-12-STABLE` from `GIT_HOST` in [.filename]#poudriere.conf# or the default `git.freebsd.org` into [.filename]#/poudriere/jails/12i386/usr/src#, then complete a `buildworld` and install it into [.filename]#/poudriere/jails/12i386#. -[TIP] -==== -If a specific Subversion revision is needed, append it to the version string. -For example: - -[source,shell] -.... -# poudriere jail -c -j 12i386 -v stable/12@123456 -a i386 -m git+https -.... - -==== - [NOTE] ==== While it is possible to build a newer version of FreeBSD on an older version, most of the time it will not run. @@ -313,38 +288,30 @@ [NOTE] ==== -To create a Poudriere jail for `14.0-CURRENT`: +To create a poudriere jail for `14.0-CURRENT`: [source,shell] .... # poudriere jail -c -j 14amd64 -v main -a amd64 -m git+https .... -In order to run a `14.0-CURRENT` Poudriere jail you must be running `14.0-CURRENT`. +In order to run a `14.0-CURRENT` poudriere jail the host must be running `14.0-CURRENT`. In general, newer kernels can build and run older jails. -For instance, a `14.0-CURRENT` kernel can build and run a `12.3-STABLE`. -Poudriere jail if the `COMPAT_FREEBSD12` kernel option was compiled in (on by default in `14.0-CURRENT`[.filename]#GENERIC# kernel config). +For instance, a `14.0-CURRENT` kernel can build and run a `12.4-STABLE` if the `COMPAT_FREEBSD12` kernel option was compiled in (on by default in `14.0-CURRENT`[.filename]#GENERIC# kernel config). ==== -[CAUTION] -==== -The default `svn` protocol works but is not very secure. -Using `svn+https` along with verifying the remote server's SSL fingerprint is advised. -It will ensure that the files used for building the jail are from a trusted source. -==== - -A list of jails currently known to Poudriere can be shown with `poudriere jail -l`: +A list of jails currently known to poudriere can be shown with `poudriere jail -l`: [source,shell] .... # poudriere jail -l JAILNAME VERSION ARCH METHOD 131Ramd64 13.1-RELEASE amd64 ftp -12i386 12.3-STABLE i386 git+https +12i386 12.4-STABLE i386 git+https .... [[testing-poudriere-maintaining-jails]] -=== Keeping Poudriere Jails Updated +=== Keeping poudriere Jails Updated Managing updates is very straightforward. The command: @@ -355,8 +322,10 @@ .... updates the specified jail to the latest version available. +pass:[] For FreeBSD releases, update to the latest patchlevel with man:freebsd-update[8]. -For FreeBSD versions built from source, update to the latest Subversion revision in the branch. +pass:[] +For FreeBSD versions built from source, update to the latest git revision in the branch. [TIP] ==== @@ -371,10 +340,10 @@ ==== [[testing-poudriere-ports-tree]] -=== Setting Up Ports Trees for Use with Poudriere +=== Setting Up Ports Trees for Use with poudriere -There are multiple ways to use ports trees in Poudriere. -The most straightforward way is to have Poudriere create a default ports tree for itself, using link:{handbook}mirrors/#git[Git]: +There are multiple ways to use ports trees in poudriere. +The most straightforward way is to have poudriere create a default ports tree for itself, using link:{handbook}mirrors/#git[Git]: [source,shell] .... @@ -400,37 +369,14 @@ The best way to deal with local modifications for a ports contributor is to use link:{handbook}mirrors/#git[Git]. As with the creation of jails, it is possible to use a different method for creating the ports tree. -To add an additional ports tree for testing local modifications and ports development, -checking out the tree via Subversion (as described above) is preferable. - -[NOTE] -==== -The http and https methods need package:devel/subversion[] built with the `SERF` option enabled. -It is enabled by default. -==== - -[TIP] -==== -The `svn` method allows extra qualifiers to tell Subversion exactly how to fetch data. -This is explained in man:poudriere[8]. -For instance, `poudriere ports -c -m svn+ssh -p subversive` uses SSH for the checkout. -==== +To add an additional ports tree for testing local modifications and ports development, checking out the tree via git (as described above) is preferable. [[testing-poudriere-ports-tree-manual]] -=== Using Manually Managed Ports Trees with Poudriere +=== Using Manually Managed Ports Trees with poudriere Depending on the workflow, it can be extremely helpful to use ports trees which are maintained manually. -For instance, if there is a local copy of the ports tree in [.filename]#/work/ports#, point Poudriere to the location: - -* For Poudriere older than version 3.1.20: -+ -[source,shell] -.... -# poudriere ports -c -F -f none -M /work/ports -p development -.... +For instance, if there is a local copy of the ports tree in [.filename]#/work/ports#, point poudriere to the location: -* For Poudriere version 3.1.20 and later: -+ [source,shell] .... # poudriere ports -c -m null -M /work/ports -p development @@ -447,12 +393,12 @@ [NOTE] ==== -The dash or `null` in the `METHOD` column means that Poudriere will not update or change this ports tree, ever. +The dash or `null` in the `METHOD` column means that poudriere will not update or change this ports tree, ever. It is completely up to the user to maintain this tree, including all local modifications that may be used for testing new ports and submitting patches. ==== [[testing-poudriere-ports-tree-updating]] -=== Keeping Poudriere Ports Trees Updated +=== Keeping poudriere Ports Trees Updated As straightforward as with jails described earlier: @@ -465,8 +411,7 @@ [NOTE] ==== -Ports trees without a method, see <>, cannot be updated like this. -They must be updated manually by the porter. +Ports trees without a method, see <>, cannot be updated like this and must be updated manually by the porter. ==== [[testing-poudriere-testing-ports]] @@ -493,7 +438,7 @@ The link points to the latest _build-time_ directory. Also in this directory is an [.filename]#index.html# for observing the build process with a web browser. -By default, Poudriere cleans up the jails and leaves log files in the directories mentioned above. +By default, poudriere cleans up the jails and leaves log files in the directories mentioned above. To ease investigation, jails can be kept running after the build by adding `-i` to `testport`: [source,shell] @@ -503,8 +448,8 @@ After the build completes, and regardless of whether it was successful, a shell is provided within the jail. The shell is used to investigate further. -Poudriere can be told to leave the jail running after the build finishes with `-I`. -Poudriere will show the command to run when the jail is no longer needed. +poudriere can be told to leave the jail running after the build finishes with `-I`. +poudriere will show the command to run when the jail is no longer needed. It is then possible to man:jexec[8] into it: [source,shell] @@ -523,7 +468,8 @@ .... An integral part of the FreeBSD ports build infrastructure is the ability to tweak ports to personal preferences with options. -These can be tested with Poudriere as well. Adding the `-c`: +These can be tested with poudriere as well. +Adding the `-c`: [source,shell] .... @@ -547,11 +493,11 @@ A set refers to a fully independent build. This allows, for instance, usage of `testport` with non-standard options for the dependent ports. -To use sets, Poudriere expects an existing directory structure similar to `PORT_DBDIR`, defaults to [.filename]#/var/db/ports# in its configuration directory. +To use sets, poudriere expects an existing directory structure similar to `PORT_DBDIR`, defaults to [.filename]#/var/db/ports# in its configuration directory. This directory is then man:nullfs[5]-mounted into the jails where the ports and their dependencies are built. Usually a suitable starting point can be obtained by recursively copying the existing `PORT_DBDIR` to [.filename]#/usr/local/etc/poudriere.d/jailname-portname-setname-options#. This is described in detail in man:poudriere[8]. -For instance, testing package:www/firefox[] in a specific set named `devset`, add the `-z devset` parameter to the testport command: +For instance, testing package:www/firefox[] in a specific set named `devset`, add the `-z devset` parameter to the `testport` command: [source,shell] .... @@ -568,7 +514,7 @@ * [.filename]#/usr/local/etc/poudriere.d/131Ramd64-options# * [.filename]#/usr/local/etc/poudriere.d/options# -From this list, Poudriere man:nullfs[5]-mounts the _first existing_ directory tree into the [.filename]#/var/db/ports# directory of the build jails. +From this list, poudriere man:nullfs[5]-mounts the _first existing_ directory tree into the [.filename]#/var/db/ports# directory of the build jails. Hence, all custom options are used for all the ports during this run of `testport`. After the directory structure for a set is provided, the options for a particular port can be altered. @@ -584,24 +530,25 @@ [NOTE] ==== -Poudriere is very flexible in the option configuration. -They can be set for particular jails, ports trees, and for multiple ports by one command. +poudriere is very flexible in the option configuration. +poudriere can be set for particular jails, ports trees, and for multiple ports by one command. Refer to man:poudriere[8] for details. ==== [[testing-poudriere-make-conf]] === Providing a Custom [.filename]#make.conf# File -Similar to using sets, Poudriere will also use a custom [.filename]#make.conf# if it is provided. +Similar to using sets, poudriere will also use a custom [.filename]#make.conf# if it is provided. No special command line argument is necessary. -Instead, Poudriere looks for existing files matching a name scheme derived from the command line. For instance: +Instead, poudriere looks for existing files matching a name scheme derived from the command line. +For instance: [source,shell] .... # poudriere testport -j 131Ramd64 -p development -z devset -o www/firefox .... -causes Poudriere to check for the existence of these files in this order: +causes poudriere to check for the existence of these files in this order: * [.filename]#/usr/local/etc/poudriere.d/make.conf# * [.filename]#/usr/local/etc/poudriere.d/devset-make.conf# @@ -636,7 +583,7 @@ [[testing-poudriere-pruning-distfiles]] === Pruning no Longer Needed Distfiles -Poudriere comes with a built-in mechanism to remove outdated distfiles that are no longer used by any port of a given tree. +poudriere comes with a built-in mechanism to remove outdated distfiles that are no longer used by any port of a given tree. The command [source,shell]