Add comment explaining the use of `readDirectory(realStoreDir)`

1 files changed, 9 insertions, 0 deletions

diff --git a/src/libstore/local-store.cc b/src/libstore/local-store.cc
index 982a9059c..40a3bc194 100644
--- a/src/libstore/local-store.cc
+++ b/src/libstore/local-store.cc
@@ -1503,6 +1503,15 @@ bool LocalStore::verifyStore(bool checkContents, RepairFlag repair)
 
     {
         StorePathSet storePathsInStoreDir;
+        /* Why aren't we using `queryAllValidPaths`? Because that would
+           tell us about all the paths than the database knows about. Here we
+           want to know about all the store paths in the store directory,
+           regardless of what the database thinks.
+
+           We will end up cross-referencing these two sources of truth (the
+           database and the filesystem) in the loop below, in order to catch
+           invalid states.
+         */
         for (auto & i : readDirectory(realStoreDir)) {
             try {
                 storePathsInStoreDir.insert({i.name});