aboutsummaryrefslogtreecommitdiff
path: root/bpkg/pkg-test.cli
blob: 6593c4d56d4bef96ca24a857c3a90d9d138fc0ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
// file      : bpkg/pkg-test.cli
// copyright : Copyright (c) 2014-2018 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

include <bpkg/configuration.cli>;

"\section=1"
"\name=bpkg-pkg-test"
"\summary=test package"

namespace bpkg
{
  {
    "<options> <vars> <pkg>",

    "\h|SYNOPSIS|

     \c{\b{bpkg pkg-test}|\b{test} [<options>] [<vars>] <pkg>...\n
        \b{bpkg pkg-test}|\b{test} [<options>] [<vars>] \b{--all}|\b{-a}}

     \h|DESCRIPTION|

     The \cb{pkg-test} command tests the specified packages (the first form)
     or all the held packages (the second form, see \l{bpkg-pkg-status(1)}).
     Additionally, immediate or all dependencies of these packages can also be
     tested by specifying the \c{\b{--immediate}|\b{-i}} or
     \c{\b{--recursive}|\b{-r}} options, respectively. Underneath, this
     command doesn't do much more than run \cb{b test}. In the first form the
     specified packages must have been previously configured with
     \l{bpkg-pkg-build(1)} or \l{bpkg-pkg-configure(1)}.

     Additional command line variables (<vars>, normally \cb{config.*}) can be
     passed to the build system. Such variables apply to all the specified
     packages but can also be specified to only apply to specific packages
     using the argument grouping mechanism (see \l{bpkg-argument-grouping(1)}
     for details)."
  }

  class pkg_test_options: configuration_options
  {
    "\h|PKG-TEST OPTIONS|"

    bool --all|-a
    {
      "Test all held packages."
    }

    bool --immediate|-i
    {
      "Also test immediate dependencies."
    }

    bool --recursive|-r
    {
      "Also test all dependencies, recursively."
    }
  };
}