aboutsummaryrefslogtreecommitdiff
path: root/bdep/project-email.hxx
blob: c63068285b9c23ad2e68bce4ebff2c4b67a6801f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// file      : bdep/project-email.hxx -*- C++ -*-
// copyright : Copyright (c) 2014-2018 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

#ifndef BDEP_PROJECT_EMAIL_HXX
#define BDEP_PROJECT_EMAIL_HXX

#include <bdep/types.hxx>
#include <bdep/utility.hxx>

namespace bdep
{
  // Given a project directly, try to discover the author's email address
  // using the environment and, if project looks like a repository, its VCS.
  //
  // Note: if using this function in a command, don't forget to update its
  // ENVIRONMENT section to mention BDEP_EMAIL.
  //
  optional<string>
  project_email (const dir_path&);
}

#endif // BDEP_PROJECT_EMAIL_HXX