Skip to content

Commit ca1027f

Browse files
committed
doc: describe the test phase of a package
1 parent a1ba908 commit ca1027f

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

doc/guide/files/build.xml

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $NetBSD: build.xml,v 1.92 2024/08/25 06:18:39 wiz Exp $ -->
1+
<!-- $NetBSD: build.xml,v 1.93 2026/02/08 09:42:35 wiz Exp $ -->
22

33
<chapter id="build">
44
<title>The build process</title>
@@ -591,8 +591,18 @@ ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
591591
<sect1 id="build.test">
592592
<title>The <emphasis>test</emphasis> phase</title>
593593

594-
<para>[TODO]</para>
595-
594+
<para>The test phase is for running a program's self
595+
tests. Dependencies that are only required for testing can be
596+
specified using <varname>TEST_DEPENDS</varname>.</para>
597+
<para>For packages using &man.make.1; for building, you can set
598+
<varname>TEST_TARGET</varname>. Often, the proper value is
599+
<quote>check</quote> or <quote>test</quote>. If more elaborate
600+
steps are needed, you can define a <literal>do-test</literal>
601+
target.</para>
602+
<para>To run the tests, call <quote>make test</quote>.</para>
603+
<para>When building a package, the tests are not run
604+
automatically, except if <varname>PKGSRC_RUN_TEST</varname> is set
605+
to <quote>yes</quote>.</para>
596606
</sect1>
597607

598608
<sect1 id="build.install">

0 commit comments

Comments
 (0)