Skip to content

Commit a410161

Browse files
ttaylorrgitster
authored andcommitted
shallow.h: document '{commit,rollback}_shallow_file'
When 'commit_shallow_file()' and 'rollback_shallow_file()' were introduced, they did not have a 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. Helped-by: Eric Sunshine <[email protected]> Signed-off-by: Taylor Blau <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 120ad2b commit a410161

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

shallow.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ void set_alternate_shallow_file(struct repository *r, const char *path, int over
1010
int register_shallow(struct repository *r, const struct object_id *oid);
1111
int unregister_shallow(const struct object_id *oid);
1212
int is_repository_shallow(struct repository *r);
13+
/* commit $GIT_DIR/shallow and reset stat-validity checks */
1314
int commit_shallow_file(struct repository *r, struct lock_file *lk);
15+
/* rollback $GIT_DIR/shallow and reset stat-validity checks */
1416
void rollback_shallow_file(struct repository *r, struct lock_file *lk);
1517

1618
struct commit_list *get_shallow_commits(struct object_array *heads,

0 commit comments

Comments
 (0)