doc: fix a typo inside --bare section

[artshade]

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

[gitgitgadget]

Welcome to GitGitGadget

Hi @vv7v7, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that your Pull Request has a good description, as it will be used as cover letter.

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

• the lines should not exceed 76 columns,
• the first line should be like a header and typically start with a prefix like "tests:" or "commit:", and
• the commit messages' body should be describing the "why?" of the change.
• Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

• Search: is:pr is:open "/allow"

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the FreeNode IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join git-mentoring@googlegroups.com, where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Freenode. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

[gitgitgadget]

Invalid author email in 3f681ec7f1e4b1be819e7a8f9de9d0494fd4cccc: "25136754+vv7v7@users.noreply.github.com"

[dscho]

it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

• the lines should not exceed 76 columns,

• the first line should be like a header and typically start with a prefix like "tests:" or "commit:", and

• the commit messages' body should be describing the "why?" of the change.

• Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

Please take these hints seriously.

Also, which PR do you want to keep open, this one, or the duplicate at git#802?

[artshade]

Also, which PR do you want to keep open, this one, or the duplicate

Thank you very much. Is it correct now? It seems that [git#802] should be kept instead of this one, isn't it? Actually, I don't know what would be the correct option.
A [git#802] was the first one, while this I've created after reading the bot's message which pointed me to this fork.

[dscho]

The commit message needs to be amended (you edited the PR description instead).

It does not matter whether you keep the git/git or the gitgitgadget/git PR. But you should close one of the two.

[gitgitgadget]

Invalid author email in 003c969d1f592f221c44c230d2635ac3484998f9: "25136754+vv7v7@users.noreply.github.com"

[gitgitgadget]

Invalid author email in 3fe021bb809412b299b8bdaae7fd92047ca1a3f4: "25136754+vv7v7@users.noreply.github.com"

[gitgitgadget]

There is an issue in commit aabb036356d712a80ec4ec5d13b2204860e1fbfd:
Prefixed commit message must be in lower case: Doc: Fix a typo inside --bare section

[gitgitgadget]

There is an issue in commit 1df96b40161ab4894de9cf2141d2401c2c96e990:
Prefixed commit message must be in lower case: Doc: Fix a typo inside --bare section

[gitgitgadget]

There is an issue in commit 5e42d8c7fd1daa7648aecc5fd75ca7a913ac811b:
Prefixed commit message must be in lower case: doc: Fix a typo inside --bare section

[dscho]

/allow

[gitgitgadget]

User vv7v7 is now allowed to use GitGitGadget.

WARNING: vv7v7 has no public email address set on GitHub

[artshade]

Thank you very much! 🙂

[artshade]

/submit

[gitgitgadget]

Submitted as pull.649.git.1591445695220.gitgitgadget@gmail.com

[gitgitgadget]

On the Git mailing list, Junio C Hamano wrote (reply to this):

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

> 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;

> -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

[gitgitgadget]

On the Git mailing list, F8ER wrote (reply to this):

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