mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

repository.h: add comment and clarify repo_set_gitdir

Browse Source 
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 <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Nguyễn Thái Ngọc Duy
2018-03-23 16:55:23 +01:00
committed by Junio C Hamano
parent 2bee50a083
commit 00a3da2a13
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
repository.h
View File

@ -82,6 +82,10 @@ struct repository {
extern struct repository *the_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 { struct set_gitdir_args {
const char *commondir; const char *commondir;
const char *object_dir; const char *object_dir;
@ -92,7 +96,7 @@ struct set_gitdir_args {
extern void repo_set_gitdir(struct repository *repo, extern void repo_set_gitdir(struct repository *repo,
const char *root, 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_worktree(struct repository *repo, const char *path);
extern void repo_set_hash_algo(struct repository *repo, int algo); extern void repo_set_hash_algo(struct repository *repo, int algo);
extern void initialize_the_repository(void); extern void initialize_the_repository(void);