aboutsummaryrefslogtreecommitdiff
path: root/bpkg/cfg-link.hxx
blob: 116512b8838327ce1006fab9dcb877ff6f1598e1 (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
// file      : bpkg/cfg-link.hxx -*- C++ -*-
// license   : MIT; see accompanying LICENSE file

#ifndef BPKG_CFG_LINK_HXX
#define BPKG_CFG_LINK_HXX

#include <bpkg/types.hxx>
#include <bpkg/forward.hxx> // configuration
#include <bpkg/utility.hxx>

#include <bpkg/cfg-link-options.hxx>

namespace bpkg
{
  int
  cfg_link (const cfg_link_options&, cli::scanner& args);

  // Link the configuration specified as the directory path with the current
  // configuration, attach the linked configuration database, and return the
  // link. Note that it also establishes an implicit back-link of the current
  // configuration with the linked one.
  //
  // The specified configuration path must be absolute and normalized. If the
  // relative argument is true, then rebase this path relative to the current
  // configuration directory path and fail if that's not possible (different
  // drive on Windows, etc).
  //
  // If the current configuration database has its explicit links pre-
  // attached, then also pre-attach explicit links of the newly linked
  // database.
  //
  shared_ptr<configuration>
  cfg_link (database&,
            const dir_path&,
            bool relative,
            optional<string> name,
            bool sys_rep = false);
}

#endif // BPKG_CFG_LINK_HXX