diff options
Diffstat (limited to 'src/buildtool/file_system/git_repo.hpp')
| -rw-r--r-- | src/buildtool/file_system/git_repo.hpp | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/buildtool/file_system/git_repo.hpp b/src/buildtool/file_system/git_repo.hpp index 2aabf7ee..4d1be53f 100644 --- a/src/buildtool/file_system/git_repo.hpp +++ b/src/buildtool/file_system/git_repo.hpp @@ -152,8 +152,9 @@ class GitRepo { using anon_logger_ptr = std::shared_ptr<anon_logger_t>; /// \brief Create tree from entries at given directory and commit it with - /// given message. Currently, the caller must guarantee that given path is - /// a subdirectory of the repository root path. + /// given message. The given path need not be a subdirectory of the + /// repository root path, but the caller must guarantee its entries are + /// readable. /// Only possible with real repository and thus non-thread-safe. /// \returns The commit hash, or nullopt if failure. It guarantees the /// logger is called exactly once with fatal if failure. |