[PATCH 4/5] shallow.h: document '{commit,rollback}_shallow_file'

From: Taylor Blau <me@ttaylorr.com>
Date: Apr 29, 2020, 22:39 UTC
Message-ID: <7828def924a767e54dd43b6c107e8f98c1698f55.1588199705.git.me@ttaylorr.com>
In-Reply-To: <cover.1588199705.git.me@ttaylorr.com>

When 'commit_shallow_file()' and 'rollback_shallow_file()' were introduced, they did not have an documenting comment, when they could have benefited from one.

Add a brief note about what these functions do, and make a special note that they reset stat-validity checks.

Signed-off-by: Taylor Blau <me@ttaylorr.com>
---
 shallow.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/shallow.h b/shallow.h
index b50a85ed7e..08e1bc4fd0 100644
--- a/shallow.h
+++ b/shallow.h
@@ -10,6 +10,10 @@ void set_alternate_shallow_file(struct repository *r, const char *path, int over
 int register_shallow(struct repository *r, const struct object_id *oid);
 int unregister_shallow(const struct object_id *oid);
 int is_repository_shallow(struct repository *r);
+/*
+ * {commit,rollback}_shallow_file commits or performs a rollback to the
+ * '.git/shallow' file, respectively, and resets stat-validity checks.
+ */
 int commit_shallow_file(struct repository *r, struct lock_file *lk);
 void rollback_shallow_file(struct repository *r, struct lock_file *lk);

-- 
2.26.0.113.ge9739cdccc