bpkg/pkg-verify.cli


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

// file      : bpkg/pkg-verify.cli
// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

include <bpkg/common.cli>;

"\section=1"
"\name=bpkg-pkg-verify"
"\summary=verify package archive"

namespace bpkg
{
  {
    "<options> <archive>",

    "\h|SYNOPSIS|

     \c{\b{bpkg pkg-verify} [<options>] <archive>}

     \h|DESCRIPTION|

     The \cb{pkg-verify} command verifies that the specified archive is a
     valid \cb{bpkg} package. Specifically, it checks that the archive's name
     and the top-level directory inside the archive match the canonical
     '\c{\i{name}\b{-}\i{version}}' form and that there is a valid manifest
     file in that top-level directory."
  }

  class pkg_verify_options: common_options
  {
    "\h|PKG-VERIFY OPTIONS|"

    bool --silent
    {
      "Suppress the error messages about the reason why the package is
       invalid. Just return the error status."
    }

    bool --ignore-unknown
    {
      "Ignore unknown manifest entries. By default, \cb{bpkg} will refuse to
       declare such a package valid since it cannot be sure the unknown entries
       are valid."
    }
  };
}