doc: fix a typo inside `--bare` section
PATCH 1/1 doc: fix a typo inside `--bare` section
From: Mark Williams <[email protected]>
Add a word variable and a $ sign before variable's name in --bare argument section. Without this word someone might be confused.
---
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.
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(-)
Documentation/git-init.txt +2 -2
@@ -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=<format>::
base-commit: 20514004ddf1a3528de8933bc32f284e175e1012
Signature · 1 line
gitgitgadget
Quoted 6 lines · Angel via GitGitGadget
From: Mark Williams <[email protected]>
Add a word
variableand a$sign before variable's name in--bareargument section. Without this word someone might be confused.
Quoted 8 lines
Signed-off-by Mark Williams <[email protected]>---
doc: fix a typo inside --bare sectiondoc: 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;
Quoted 9 lines
Documentation/git-init.txt +2
-2-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
Dear Junio C Hamano,
Thanks!
Quoted 2 lines · Junio C Hamano
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.
Quoted 2 lines
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