diff options
author | aameen-tulip <98349328+aameen-tulip@users.noreply.github.com> | 2023-02-16 18:47:45 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-02-16 18:47:45 -0600 |
commit | b31d4b689ca9f82e1c4060ea41e92691d5c94ee8 (patch) | |
tree | dfaf693fe6cd5250f3abe4f8b741580b4df40fb0 /src/libfetchers/fetchers.hh | |
parent | a88ae62bc0e404b7f87876bfd0a74afbac4d517d (diff) |
Document `hasAllInfo`
If this documentation is inaccurate in any way please do not hesitate to suggest corrections.
My understanding of this function is strictly from reading the source code and some limited experience implementing fetchers.
Diffstat (limited to 'src/libfetchers/fetchers.hh')
-rw-r--r-- | src/libfetchers/fetchers.hh | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/libfetchers/fetchers.hh b/src/libfetchers/fetchers.hh index 17da37f47..95c0f5974 100644 --- a/src/libfetchers/fetchers.hh +++ b/src/libfetchers/fetchers.hh @@ -63,6 +63,11 @@ public: one that contains a commit hash or content hash. */ bool isLocked() const { return locked; } + /* Check whether the input carries all necessary info required + for cache insertion and substitution. + These fields are used to uniquely identify cached trees + within the "tarball TTL" window without necessarily + indicating that the input's origin is unchanged. */ bool hasAllInfo() const; bool operator ==(const Input & other) const; |