Re: [PATCH] doc: fix a typo inside `--bare` section

From: Junio C Hamano <gitster@pobox.com>
Date: Jun 7, 2020, 17:01 UTC
Message-ID: <xmqqh7vmn72l.fsf@gitster.c.googlers.com>
In-Reply-To: <pull.649.git.1591445695220.gitgitgadget@gmail.com>

"Angel via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 14 quoted lines

> From: Mark Williams <the.f8er@gmail.com>
>
> Add a word `variable` and a `$` sign before variable's
> name in `--bare` argument section. Without this word someone
> might be confused.
>
> Signed-off-by: Mark Williams <the.f8er@gmail.com>
> ---
>     doc: fix a typo inside --bare section
>     
>     doc: fix a typo inside --bare section
>     
>     Add a word variable and a $ sign before variable's name in --bare 
>     argument section. Without this word someone might be confused.

A quick and dirty

  $ git grep 'GIT_[A-Z]*[^A-Za-z0-9] .*environment' Documentation/

tells us that adding "environment variable" is probably the right thing to do, but we should not add the variable dereference '$' in front (and fix some that do spell $GIT_PAGER etc. to lose '$').

In shell, $V is a notation to always name the value in the variable, and it is clearer to refer to the variable itself without the '$' sign. '$V' means "the value that currently is in the variable V".

	V=newvalue
	W="old value of $V"

This is unlike C where using a variable as lvalue on the left hand side of assignment does not need different spelling as the variable is used as rvalue, e.g.

	variable = newvalue;
	another_variable = 2 * variable;

Show 9 quoted lines

> -Create a bare repository. If `GIT_DIR` environment is not set, it is set to the
> -current working directory.
> +Create a bare repository. If the `$GIT_DIR` environment variable is not set, it
> +is set to the current working directory.
>  
>  --object-format=<format>::
>  
>
> base-commit: 20514004ddf1a3528de8933bc32f284e175e1012