Subject: [PATCH 1/1] repository.h: add comment and clarify repo_set_gitdir

From: Nguyễn Thái Ngọc Duy <[email-masked]>
Date: Fri, 23 Mar 2018 16:55:23 +0100

The argument name "optional" may mislead the reader to think this
option could be NULL. But it can't be. While at there, document a bit
more about struct set_gitdir_args.

Signed-off-by: Nguyễn Thái Ngọc Duy <[email-masked]>
---
 repository.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/repository.h b/repository.h
index e7127baffb..f21fd93f72 100644
--- a/repository.h
+++ b/repository.h
@@ -82,6 +82,10 @@ struct repository {
 
 extern struct repository *the_repository;
 
+/*
+ * Define a custom repository layout. Any field can be NULL, which
+ * will default back to the path according to the default layout.
+ */
 struct set_gitdir_args {
 	const char *commondir;
 	const char *object_dir;
@@ -92,7 +96,7 @@ struct set_gitdir_args {
 
 extern void repo_set_gitdir(struct repository *repo,
 			    const char *root,
-			    const struct set_gitdir_args *optional);
+			    const struct set_gitdir_args *extra_args);
 extern void repo_set_worktree(struct repository *repo, const char *path);
 extern void repo_set_hash_algo(struct repository *repo, int algo);
 extern void initialize_the_repository(void);
-- 
2.17.0.rc0.348.gd5a49e0b6f