diff mbox series

environment: fix typo: 'setup_git_directory_gently'

Message ID 20250418185855.52950-1-abhijeet.nkt@gmaiil.com (mailing list archive)
State New
Headers show
Series environment: fix typo: 'setup_git_directory_gently' | expand

Commit Message

Abhijeet Sonar April 18, 2025, 6:58 p.m. UTC
From: Abhijeet Sonar <abhijeet.nkt@gmail.com>

Above the declaration of git_work_tree_cfg, we have:

  /* This is set by setup_git_dir_gently() and/or git_default_config() */
  char *git_work_tree_cfg;

It can be verified that there is no function called
'setup_git_dir_gently' by running grep on the codebase:

  $ grep -R setup_git_dir_gently .
  ./environment.c:/* This is set by setup_git_dir_gently() and/or git_default_config() */

The comment, introduced in e90fdc39b6 (Clean up work-tree handling), is
the only occurrence of the name 'setup_git_dir_gently'.

It probably meant 'setup_git_directory_gently' as that is a name of a
real function in setup.c. Correct it.

Signed-off-by: Abhijeet Sonar <abhijeet.nkt@gmail.com>
---
 environment.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Junio C Hamano April 18, 2025, 9:04 p.m. UTC | #1
Abhijeet Sonar <abhijeet.nkt@gmail.com> writes:

> From: Abhijeet Sonar <abhijeet.nkt@gmail.com>
>
> Above the declaration of git_work_tree_cfg, we have:
>
>   /* This is set by setup_git_dir_gently() and/or git_default_config() */
>   char *git_work_tree_cfg;
>
> It can be verified that there is no function called
> 'setup_git_dir_gently' by running grep on the codebase:
>
>   $ grep -R setup_git_dir_gently .
>   ./environment.c:/* This is set by setup_git_dir_gently() and/or git_default_config() */
>
> The comment, introduced in e90fdc39b6 (Clean up work-tree handling), is
> the only occurrence of the name 'setup_git_dir_gently'.
>
> It probably meant 'setup_git_directory_gently' as that is a name of a
> real function in setup.c. Correct it.
>
> Signed-off-by: Abhijeet Sonar <abhijeet.nkt@gmail.com>
> ---
>  environment.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Will queue.  Thanks for a well-written patch.

> diff --git a/environment.c b/environment.c
> index 3c32367c28..970a407753 100644
> --- a/environment.c
> +++ b/environment.c
> @@ -106,7 +106,7 @@ int auto_comment_line_char;
>  /* Parallel index stat data preload? */
>  int core_preload_index = 1;
>  
> -/* This is set by setup_git_dir_gently() and/or git_default_config() */
> +/* This is set by setup_git_directory_gently() and/or git_default_config() */
>  char *git_work_tree_cfg;
>  
>  /*
diff mbox series

Patch

diff --git a/environment.c b/environment.c
index 3c32367c28..970a407753 100644
--- a/environment.c
+++ b/environment.c
@@ -106,7 +106,7 @@  int auto_comment_line_char;
 /* Parallel index stat data preload? */
 int core_preload_index = 1;
 
-/* This is set by setup_git_dir_gently() and/or git_default_config() */
+/* This is set by setup_git_directory_gently() and/or git_default_config() */
 char *git_work_tree_cfg;
 
 /*