summaryrefslogtreecommitdiff
path: root/src/buildtool/file_system/git_repo.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/buildtool/file_system/git_repo.hpp')
-rw-r--r--src/buildtool/file_system/git_repo.hpp9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/buildtool/file_system/git_repo.hpp b/src/buildtool/file_system/git_repo.hpp
index f8591d75..4d54e23e 100644
--- a/src/buildtool/file_system/git_repo.hpp
+++ b/src/buildtool/file_system/git_repo.hpp
@@ -348,13 +348,17 @@ class GitRepo {
/// \brief Open real repository at given location.
explicit GitRepo(std::filesystem::path const& repo_path) noexcept;
- using StoreDirEntryFunc =
- std::function<bool(std::filesystem::path const&, ObjectType type)>;
+ /// \brief Function type handling directory entries read from filesystem.
+ /// \returns Success flag. Must guarantee that the logger is called exactly
+ /// once with fatal if returning false.
+ using StoreDirEntryFunc = std::function<
+ bool(std::filesystem::path const&, ObjectType, anon_logger_ptr const&)>;
/// \brief Helper function to read the entries of a filesystem subdirectory
/// and store them to the ODB. It is a modified version of the same-named
/// function from FileSystemManager which accepts a subdir and a specific
/// logger instead of the default.
+ /// It guarantees the logger is called exactly once with fatal if failure.
[[nodiscard]] static auto ReadDirectory(
std::filesystem::path const& dir,
StoreDirEntryFunc const& read_and_store_entry,
@@ -363,6 +367,7 @@ class GitRepo {
/// \brief Create a tree from the content of a directory by recursively
/// adding its entries to the object database.
/// \return The raw id of the tree.
+ /// It guarantees the logger is called exactly once with fatal if failure.
[[nodiscard]] auto CreateTreeFromDirectory(
std::filesystem::path const& dir,
anon_logger_ptr const& logger) noexcept -> std::optional<std::string>;