From f2fe9822c14bc86e5da8f8cb97cb16a961ecc46f Mon Sep 17 00:00:00 2001
From: Ben Radford <benradf@users.noreply.github.com>
Date: Thu, 15 Jun 2023 13:31:37 +0100
Subject: [PATCH] Comment explaining what schema version 0 means.

---
 src/libstore/local-store.hh | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/libstore/local-store.hh b/src/libstore/local-store.hh
index a1ab3bb4d..dd563348b 100644
--- a/src/libstore/local-store.hh
+++ b/src/libstore/local-store.hh
@@ -285,6 +285,10 @@ public:
 
 private:
 
+    /**
+     * Retrieve the current version of the database schema.
+     * If the database does not exist yet, the version returned will be 0.
+     */
     int getSchema();
 
     void openDB(State & state, bool create);