# [PATCH] doc: fix a typo inside `--bare` section 3 messages from 2020-06-06 to 2020-06-07. Participants: Angel via GitGitGadget, Junio C Hamano, F8ER. Thread: https://gitlist.dev/t/53623 ## Angel via GitGitGadget, 2020-06-06 12:14 Subject: [PATCH] doc: fix a typo inside `--bare` section Message-ID: URL: https://gitlist.dev/e/pull.649.git.1591445695220.gitgitgadget%40gmail.com ``` From: Mark Williams 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 --- 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. Signed-off-by: Mark Williams the.f8er@gmail.com [the.f8er@gmail.com] Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-649%2Fvv7v7%2Fpatch-3-v1 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-649/vv7v7/patch-3-v1 Pull-Request: https://github.com/gitgitgadget/git/pull/649 Documentation/git-init.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index adc6adfd380..7f8b0bd6c4d 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -45,8 +45,8 @@ Only print error and warning messages; all other output will be suppressed. --bare:: -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=:: base-commit: 20514004ddf1a3528de8933bc32f284e175e1012 -- gitgitgadget ``` ## Junio C Hamano, 2020-06-07 17:01 Subject: Re: [PATCH] doc: fix a typo inside `--bare` section Message-ID: URL: https://gitlist.dev/e/xmqqh7vmn72l.fsf%40gitster.c.googlers.com In-Reply-To: ``` "Angel via GitGitGadget" writes: > From: Mark Williams > > 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 > --- > 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; > -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=:: > > > base-commit: 20514004ddf1a3528de8933bc32f284e175e1012 ``` ## F8ER, 2020-06-07 18:54 Subject: Re: [PATCH] doc: fix a typo inside `--bare` section Message-ID: <65cb716b-2766-e066-1d0e-21c899223060@gmail.com> URL: https://gitlist.dev/e/65cb716b-2766-e066-1d0e-21c899223060%40gmail.com In-Reply-To: ``` Dear Junio C Hamano, Thanks! On 6/7/2020 7:01 PM, Junio C Hamano wrote: > tells us that adding "environment variable" is probably the right > thing to do, What should I do next? I mean, how to achieve this? This is the first time me doing that. > but we should not add the variable dereference '$' in > front (and fix some that do spell $GIT_PAGER etc. to lose '$'). Should I remove it from commit, if so, how to? Best regards, Mark ```