diff options
Diffstat (limited to 'documentation/content/en/books/porters-handbook/testing/_index.adoc')
| -rw-r--r-- | documentation/content/en/books/porters-handbook/testing/_index.adoc | 333 |
1 files changed, 169 insertions, 164 deletions
diff --git a/documentation/content/en/books/porters-handbook/testing/_index.adoc b/documentation/content/en/books/porters-handbook/testing/_index.adoc index c32e4205ac..85433d1df0 100644 --- a/documentation/content/en/books/porters-handbook/testing/_index.adoc +++ b/documentation/content/en/books/porters-handbook/testing/_index.adoc @@ -3,10 +3,11 @@ title: Chapter 10. Testing the Port prev: books/porters-handbook/pkg-files next: books/porters-handbook/upgrading description: Testing a FreeBSD Port -tags: ["testing", "port", "Portclippy", "Portfmt", "Portlint", "Poudriere", "sets"] +tags: ["testing", "port", "Portclippy", "Portfmt", "Portlint", "poudriere", "sets"] showBookMenu: true weight: 10 -path: "/books/porters-handbook/" +params: + path: "/books/porters-handbook/testing/" --- [[testing]] @@ -65,6 +66,35 @@ See [.filename]#bsd.port.mk# for the meaning of the string produced. Also note that running a recent version of `portlint` (as specified in the next section) will cause `make describe` to be run automatically. +[[make-test]] +== Running `make test` + +Even if the port builds fine, it is a good idea to ensure that the software +correctly does what it is supposed to do. +If the original upstream project provides tests along with the software, it is a +good idea to run them and check everything works as expected. + +A port can enable tests automatically by using the `TEST_TARGET` variable. +When set, this variable contains the name of the testing target of the port. +This is usually just `test` but other names include `tests`, `check` or for +specific cases things like `run_tests.py`. + +In addition to the `TEST_TARGET` variable the framework provides the following +variables to control the tests execution: + +* `TEST_WRKSRC` is the directory to do the tests in. +* `TEST_ENV` contains additional variables to be passed to the test stage. +* `TEST_ARGS` contains any extra arguments passed to the test stage. + +Examples of use of these variables can be found in package:cad/xyce[], +package:www/libjwt[] and others. + +[NOTE] +==== +Please make sure that tests do not break when updating a port. +==== + + [[testing-portclippy]] == Portclippy / Portfmt @@ -79,7 +109,7 @@ Portfmt is a tool for automatically formatting [.filename]#Makefile#. 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. @@ -91,8 +121,10 @@ When in doubt, the best thing to do is ask on {freebsd-ports}. The package:ports-mgmt/porttools[] program is part of the Ports Collection. `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 <<testing-portlint,`portlint`>> checking. -This command also detects and lists any files that are not listed in [.filename]#pkg-plist#. For example: +Whenever a new port or an update to an existing one needs testing, use `port +test` to test the port, including the crossref:testing[testing-portlint,`portlint`] checking. +This command also detects and lists any files that are not listed in [.filename]#pkg-plist#. +For example: [source,shell] .... @@ -139,7 +171,7 @@ In addition, it is worth checking the same with the stage directory support (see * `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. @@ -159,13 +191,13 @@ The path with `LOCALBASE` is more likely to still work if the system administrat ==== All these tests are done automatically when running `poudriere testport` or `poudriere bulk -t`. It is highly recommended that every ports contributor install and test their ports with it. -See <<testing-poudriere>> for more information. +See crossref:testing[testing-poudriere, poudriere] for more information. ==== [[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 +207,15 @@ Its main features include: * 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 +223,9 @@ The ports tree, represented by `${PORTSDIR}`, is located in [.filename]#/usr/por 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 +240,7 @@ or # 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,40 +251,34 @@ in a way that will shorten a full build from 18 hours to 17 hours when using a h 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]. +Each parameter is documented in the configuration file. + Here is a minimal example config file: [.programlisting] .... -ZPOOL=tank -ZROOTFS=/poudriere -BASEFS=/poudriere +ZPOOL=zroot +BASEFS=/usr/local/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,92 +286,62 @@ This is needed so jails can resolve the URLs of distfiles when downloading. 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. -Also used for ports tree when not using man:portsnap[8]. -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] .... -# poudriere jail -c -j 114Ramd64 -v 11.4-RELEASE -a amd64 +# poudriere jail -c -j 143Ramd64 -v 14.3-RELEASE -a amd64 .... -Fetch a `11.4-RELEASE` for `amd64` from the FTP server given by `FREEBSD_HOST` in [.filename]#poudriere.conf#, -create the zfs file system `tank/poudriere/jails/114Ramd64`, -mount it on [.filename]#/poudriere/jails/114Ramd64# and extract the `11.4-RELEASE` tarballs into this file system. +Fetch a `14.3-RELEASE` for `amd64` from the HTTPS server given by `FREEBSD_HOST` in [.filename]#poudriere.conf#, +create the zfs file system `tank/poudriere/jails/143Ramd64`, +mount it on [.filename]#/poudriere/jails/143Ramd64# and extract the `14.3-RELEASE` tarballs into this file system. [source,shell] .... -# poudriere jail -c -j 11i386 -v stable/11 -a i386 -m git+https +# poudriere jail -c -j 13i386 -v stable/13 -a i386 -m git+https .... -Create `tank/poudriere/jails/11i386`, mount it on [.filename]#/poudriere/jails/11i386#, -then check out the tip of the Subversion branch of `FreeBSD-11-STABLE` from `SVN_HOST` in [.filename]#poudriere.conf# into [.filename]#/poudriere/jails/11i386/usr/src#, -then complete a `buildworld` and install it into [.filename]#/poudriere/jails/11i386#. - -[TIP] -==== -If a specific Subversion revision is needed, append it to the version string. -For example: - -[source,shell] -.... -# poudriere jail -c -j 11i386 -v stable/11@123456 -a i386 -m git+https -.... - -==== +Create `tank/poudriere/jails/13i386`, mount it on [.filename]#/poudriere/jails/13i386#, +then check out the tip of the Git branch of `FreeBSD-13-STABLE` from `GIT_HOST` in [.filename]#poudriere.conf# or the default `git.freebsd.org` into [.filename]#/poudriere/jails/13i386/usr/src#, +then complete a `buildworld` and install it into [.filename]#/poudriere/jails/13i386#. [NOTE] ==== While it is possible to build a newer version of FreeBSD on an older version, most of the time it will not run. -For example, if a `stable/11` jail is needed, the host will have to run `stable/11` too. -Running `11.4-RELEASE` is not enough. +For example, if a `stable/14` jail is needed, the host will have to run `stable/14` too. +Running `14.3-RELEASE` is not enough. ==== [NOTE] ==== -To create a Poudriere jail for `14.0-CURRENT`: +To create a poudriere jail for `16.0-CURRENT`: [source,shell] .... -# poudriere jail -c -j 14amd64 -v main -a amd64 -m git+https +# poudriere jail -c -j 16amd64 -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 `16.0-CURRENT` poudriere jail the host must be running `16.0-CURRENT`. In general, newer kernels can build and run older jails. -For instance, a `14.0-CURRENT` kernel can build and run a `11.4-STABLE`. -Poudriere jail if the `COMPAT_FREEBSD11` kernel option was compiled in (on by default in `14.0-CURRENT`[.filename]#GENERIC# kernel config). +For instance, a `16.0-CURRENT` kernel can build and run a `14.3-STABLE` if the `COMPAT_FREEBSD14` kernel option was compiled in (on by default in `16.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 -114Ramd64 11.4-RELEASE amd64 ftp -11i386 11.4-STABLE i386 svn+https +143Ramd64 14.3-RELEASE amd64 http +13i386 13.5-STABLE i386 git+https .... [[testing-poudriere-maintaining-jails]] -=== Keeping Poudriere Jails Updated +=== Keeping poudriere Jails Updated Managing updates is very straightforward. The command: @@ -357,7 +353,7 @@ The command: updates the specified jail to the latest version available. 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. +For FreeBSD versions built from source, update to the latest git revision in the branch. [TIP] ==== @@ -372,31 +368,24 @@ For example, if the building machine has 6 CPUs, use: ==== [[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 either man:portsnap[8] (if running FreeBSD {rel121-current} or {rel114-current}) or Git (if running FreeBSD-CURRENT): - -[source,shell] -.... -# poudriere ports -c -m portsnap -.... - -or +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] .... # poudriere ports -c -m git+https -B main .... -These commands create `tank/poudriere/ports/default`, mount it on [.filename]#/poudriere/ports/default#, and populate it using Git, man:portsnap[8], or Subversion. +These commands create `tank/poudriere/ports/default`, mount it on [.filename]#/poudriere/ports/default#, and populate it using Git. Afterward it is included in the list of known ports trees: [source,shell] .... # poudriere ports -l PORTSTREE METHOD TIMESTAMP PATH -default git+https 2020-07-20 04:23:56 /poudriere/ports/default +default git+https 2025-07-20 04:23:56 /poudriere/ports/default .... [NOTE] @@ -406,39 +395,16 @@ Each of the build commands explained later will implicitly use this ports tree u To use another tree, add `-p _treename_` to the commands. ==== -While useful for regular bulk builds, having this default ports tree with the man:portsnap[8] method may not be the best way to deal with local modifications for a ports contributor. +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 @@ -450,17 +416,17 @@ This will be listed in the table of known trees: .... # poudriere ports -l PORTSTREE METHOD TIMESTAMP PATH -development null 2020-07-20 05:06:33 /work/ports +development null 2025-07-20 05:06:33 /work/ports .... [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: @@ -473,8 +439,8 @@ Will update the given _PORTSTREE_, one tree given by the output of `poudriere -l [NOTE] ==== -Ports trees without a method, see <<testing-poudriere-ports-tree-manual>>, cannot be updated like this. -They must be updated manually by the porter. +Ports trees without a method, see +crossref:testing[testing-poudriere-ports-tree-manual, Using Manually Managed Ports Trees with poudriere], cannot be updated like this and must be updated manually by the porter. ==== [[testing-poudriere-testing-ports]] @@ -482,11 +448,11 @@ They must be updated manually by the porter. After jails and ports trees have been set up, the result of a contributor's modifications to the ports tree can be tested. -For example, local modifications to the package:www/firefox[] port located in [.filename]#/work/ports/www/firefox# can be tested in the previously created 11.4-RELEASE jail: +For example, local modifications to the package:www/firefox[] port located in [.filename]#/work/ports/www/firefox# can be tested in the previously created 14.3-RELEASE jail: [source,shell] .... -# poudriere testport -j 114Ramd64 -p development -o www/firefox +# poudriere testport -j 143Ramd64 -p development -o www/firefox .... This will build all dependencies of Firefox. @@ -494,53 +460,55 @@ If a dependency has been built previously and is still up-to-date, the pre-built If a dependency has no up-to-date package, one will be built with default options in a jail. Then Firefox itself is built. -The complete build of every port is logged to [.filename]#/poudriere/data/logs/bulk/114Ri386-development/build-time/logs#. +The complete build of every port is logged to [.filename]#/poudriere/data/logs/bulk/143Ri386-development/build-time/logs#. -The directory name `114Ri386-development` is derived from the arguments to `-j` and `-p`, respectively. -For convenience, a symbolic link [.filename]#/poudriere/data/logs/bulk/114Ri386-development/latest# is also maintained. +The directory name `143Ri386-development` is derived from the arguments to `-j` and `-p`, respectively. +For convenience, a symbolic link [.filename]#/poudriere/data/logs/bulk/143Ri386-development/latest# is also maintained. 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] .... -# poudriere testport -j 114Ramd64 -p development -i -o www/firefox +# poudriere testport -j 143Ramd64 -p development -i -o www/firefox .... 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] .... -# poudriere testport -j 114Ramd64 -p development -I -o www/firefox +# poudriere testport -j 143Ramd64 -p development -I -o www/firefox [...] ====>> Installing local Pkg repository to /usr/local/etc/pkg/repos -====>> Leaving jail 114Ramd64-development-n running, mounted at /poudriere/data/.m/114Ramd64-development/ref for interactive run testing -====>> To enter jail: jexec 114Ramd64-development-n env -i TERM=$TERM /usr/bin/login -fp root -====>> To stop jail: poudriere jail -k -j 114Ramd64 -p development -# jexec 114Ramd64-development-n env -i TERM=$TERM /usr/bin/login -fp root +====>> Leaving jail 143Ramd64-development-n running, mounted at /poudriere/data/.m/143Ramd64-development/ref for interactive run testing +====>> To enter jail: jexec 143Ramd64-development-n env -i TERM=$TERM /usr/bin/login -fp root +====>> To stop jail: poudriere jail -k -j 143Ramd64 -p development +# jexec 143Ramd64-development-n env -i TERM=$TERM /usr/bin/login -fp root # [do some stuff in the jail] # exit -# poudriere jail -k -j 114Ramd64 -p development +# poudriere jail -k -j 143Ramd64 -p development ====>> Umounting file systems .... 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] .... -# poudriere testport -c -o www/firefox +# poudriere testport -j 143Ramd64 -c -o www/firefox .... Presents the port configuration dialog before the port is built. The ports given after `-o` in the format `_category_/_portname_` will use the specified options, all dependencies will use the default options. -Testing dependent ports with non-default options can be accomplished using sets, see <<testing-poudriere-sets>>. +Testing dependent ports with non-default options can be accomplished using sets, +see crossref:testing[testing-poudriere-sets, Using Sets]. [TIP] ==== @@ -555,28 +523,28 @@ For all actions involving builds, a so-called _set_ can be specified using `-z _ 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] .... -# poudriere testport -j 114Ramd64 -p development -z devset -o www/firefox +# poudriere testport -j 143Ramd64 -p development -z devset -o www/firefox .... This will look for the existence of these directories in this order: -* [.filename]#/usr/local/etc/poudriere.d/114Ramd64-development-devset-options# -* [.filename]#/usr/local/etc/poudriere.d/114Ramd64-devset-options# -* [.filename]#/usr/local/etc/poudriere.d/114Ramd64-development-options# +* [.filename]#/usr/local/etc/poudriere.d/143Ramd64-development-devset-options# +* [.filename]#/usr/local/etc/poudriere.d/143Ramd64-devset-options# +* [.filename]#/usr/local/etc/poudriere.d/143Ramd64-development-options# * [.filename]#/usr/local/etc/poudriere.d/devset-options# * [.filename]#/usr/local/etc/poudriere.d/development-options# -* [.filename]#/usr/local/etc/poudriere.d/114Ramd64-options# +* [.filename]#/usr/local/etc/poudriere.d/143Ramd64-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. @@ -592,36 +560,37 @@ The selected options are saved to the `devset` set. [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 114Ramd64 -p development -z devset -o www/firefox +# poudriere testport -j 143Ramd64 -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# * [.filename]#/usr/local/etc/poudriere.d/development-make.conf# -* [.filename]#/usr/local/etc/poudriere.d/114Ramd64-make.conf# -* [.filename]#/usr/local/etc/poudriere.d/114Ramd64-development-make.conf# -* [.filename]#/usr/local/etc/poudriere.d/114Ramd64-devset-make.conf# -* [.filename]#/usr/local/etc/poudriere.d/114Ramd64-development-devset-make.conf# +* [.filename]#/usr/local/etc/poudriere.d/143Ramd64-make.conf# +* [.filename]#/usr/local/etc/poudriere.d/143Ramd64-development-make.conf# +* [.filename]#/usr/local/etc/poudriere.d/143Ramd64-devset-make.conf# +* [.filename]#/usr/local/etc/poudriere.d/143Ramd64-development-devset-make.conf# Unlike with sets, all of the found files will be appended, _in that order_, into one [.filename]#make.conf# inside the build jails. It is hence possible to have general make variables, intended to affect all builds in [.filename]#/usr/local/etc/poudriere.d/make.conf#. -Special variables, intended to affect only certain jails or sets can be set in specialised [.filename]#make.conf# files, such as [.filename]#/usr/local/etc/poudriere.d/114Ramd64-development-devset-make.conf#. +Special variables, intended to affect only certain jails or sets can be set in specialised [.filename]#make.conf# files, such as [.filename]#/usr/local/etc/poudriere.d/143Ramd64-development-devset-make.conf#. [[testing-poudriere-sets-perl]] .Using [.filename]#make.conf# to Change Default Perl @@ -644,7 +613,7 @@ Note the use of `+=` so that if the variable is already set in the default [.fil [[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] @@ -660,3 +629,39 @@ To skip the prompt and remove all unused files unconditionally, the `-y` argumen .... # poudriere distclean -p portstree -y .... + +[[testing-debugging-ports]] +== Debugging ports + +Sometimes things go wrong and the port fails at run time. +The framework provides some facilities to help in debugging ports. +These helpers are limited since the way of debugging a port heavily depends on +the technology used. +The following variables help with debugging ports: + +* `WITH_DEBUG`. If set, ports are built with debugging symbols. +* `WITH_DEBUG_PORTS`. Specifies a list of ports to be built with `WITH_DEBUG` set. +* `DEBUG_FLAGS`. Used to specify additional flags to `CFLAGS`. Defaults to `-g`. + +When `WITH_DEBUG` is set, either globally or for a list of ports, the resulting +binaries are not stripped. + +These variables can be specified in [.filename]#make.conf# or in the command +line: + +[source,shell] +.... +# cd category/port && make -DWITH_DEBUG DEBUG_FLAGSS="-g -O0" +.... + +[NOTE] +==== +If the port is built using package:ports-mgmt/poudriere[] the debugging +variables must be specified in poudriere's [.filename]#make.conf# and not in +[.filename]#/etc/make.conf#. +Refer to package:ports-mgmt/poudriere[] documentation for details. +==== + +Please refer to the debugging information in the +extref:{developers-handbook}tools[Developer's Handbook, debugging] +for more details about the debugging tools available. |