Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

core.txt: add default value to core.autocrlf document #588

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hikaen2
Copy link

@hikaen2 hikaen2 commented Mar 28, 2020

I need default value in document.

see also https://github.com/git/git/blob/v2.26.0/environment.c#L53

@gitgitgadget
Copy link

gitgitgadget bot commented Mar 28, 2020

Welcome to GitGitGadget

Hi @hikaen2, 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:

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 [email protected], 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
Copy link

gitgitgadget bot commented Mar 28, 2020

Invalid author email in f916166a99421dc0bce05c5174b1e3284974fad6: "[email protected]"

@@ -195,6 +195,7 @@ core.autocrlf::
working directory and the repository has LF line endings.
This variable can be set to 'input',
in which case no output conversion is performed.
The default value is false.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is not correct, in general. On Windows, it is true.

Copy link
Author

@hikaen2 hikaen2 Mar 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is not correct, in general. On Windows, it is true.

I tried on windows, without autocrlf.
default looks like false:
Screenshot
(test repo: https://github.com/hikaen2/crlf)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When you install Git for Windows and leave all the default values, core.autocrlf is true. Most users will keep the defaults.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understood.
Installer sets autocrlf=true.
So if I remove the autocrlf settings, what is the value of autocrlf?
I want to know the default value.

@dscho
Copy link
Member

dscho commented Mar 28, 2020

@hikaen2 welcome to the Git contributors community!

Please take a moment to compare your commit message to existing commits' messages: you will find that the Git project typically wants a lot more context accompanying the patches. Also, the change is not quite correct, it should mention that the default is platform-specific, and true on Windows, false everywhere else. Other than that, the patch makes sense to me, although I would love to see some sort of motivation in the commit message, so that the reader immediately understands why this change is desirable.

@dscho
Copy link
Member

dscho commented Mar 28, 2020

/allow

@gitgitgadget
Copy link

gitgitgadget bot commented Mar 28, 2020

User hikaen2 is now allowed to use GitGitGadget.

WARNING: hikaen2 has no public email address set on GitHub

@hikaen2 hikaen2 changed the title add default value to core.autocrlf document core.txt: add default value to core.autocrlf document Mar 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants