bpkg/pkg-drop-options.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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

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

include <bpkg/configuration-options.cli>;

"\section=1"
"\name=bpkg-pkg-drop"
"\summary=drop one or more packages"

/*
"\h{SYNOPSIS}

bpkg pkg-drop [<options>] <pkg>..."

"\h{DESCRIPTION}

The \cb{pkg-drop} command drops one or more packages from the configuration.
If the packages being dropped still have dependents, then those will have
to be drop as well and you will be prompted for a confirmation. Similarly,
if the packages being dropped have prerequisites that are no longer needed,
you will be offered to drop those as well.

The \cb{pkg-drop} command also supports several \cb{--*-only} options that
allow you to limit the amount of work that will be done.
*/

namespace bpkg
{
  class pkg_drop_options: configuration_options
  {
    bool --yes|-y
    {
      "Assume the answer to all prompts is \cb{yes}. Note that this option
       does not apply to the dropping of dependents; use \cb{--drop-dependent}
       for that."
    }

    bool --no|-n
    {
      "Assume the answer to all prompts is \cb{no}. Only makes sense together
       with \cb{--print-only|-p}."
    }

    bool --drop-dependent
    {
      "Don't warn about or ask for confirmation of dropping dependent
       packages."
    }

    bool --disfigure-only
    {
      "Disfigure all the packages but don't purge."
    }

    bool --print-only|-p
    {
      "Print to \cb{STDOUT} what would be done without actually doing
       anything."
    }
  };
}