Skip to content

Commit c52eefc

Browse files
committed
Clarify comment
1 parent 71e4d2a commit c52eefc

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/build_helper/src/git.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,16 @@ pub enum PathFreshness {
6161
/// The function behaves differently in CI and outside CI.
6262
///
6363
/// - Outside CI, we want to find out if `target_paths` were modified in some local commit on
64-
/// top of the local master branch.
64+
/// top of the latest upstream commit that is available in local git history.
6565
/// If not, we try to find the most recent upstream commit (which we assume are commits
6666
/// made by bors) that modified `target_paths`.
6767
/// We don't want to simply take the latest master commit to avoid changing the output of
6868
/// this function frequently after rebasing on the latest master branch even if `target_paths`
6969
/// were not modified upstream in the meantime. In that case we would be redownloading CI
7070
/// artifacts unnecessarily.
7171
///
72-
/// - In CI, we always fetch only a single parent merge commit, so we do not have access
72+
/// - In CI, we use a shallow clone of depth 2, i.e., we fetch only a single parent commit
73+
/// (which will be the most recent bors merge commit) and do not have access
7374
/// to the full git history.
7475
/// Luckily, we only need to distinguish between two situations. The first is that the current
7576
/// PR made modifications to `target_paths`. If not, then we simply take the latest upstream

0 commit comments

Comments
 (0)