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

doc: fix recommendation to use useless config #12445

Closed
wants to merge 1 commit into from
Closed

doc: fix recommendation to use useless config #12445

wants to merge 1 commit into from

Conversation

matkoniecz
Copy link
Contributor

Checklist
Affected core subsystem(s)

doc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 16, 2017
@benjamingr
Copy link
Member

Why useless?

@gibfahn
Copy link
Member

gibfahn commented Apr 16, 2017

Why useless?

See: #11412

Copy link
Member

@gibfahn gibfahn left a comment

Choose a reason for hiding this comment

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

I think it should be git config --global --add apply.whitespace fix, as that fixes whitespace when you apply a patch, which is where a collaborator would need it.

Also a Refs: https://github.com/nodejs/node/issues/11412 in the commit message would be good.

@gibfahn
Copy link
Member

gibfahn commented Apr 16, 2017

Please could you format your commit message according to the Contributing Guidelines?

Maybe something like this?

doc: correct git fix whitespace command

Refs: https://github.com/nodejs/node/issues/11412

If you don't have time it can be rewritten by whoever lands this, but if you are going to help out more on the project (as I hope you do), then it saves work if you produce better commit messages.

@matkoniecz
Copy link
Contributor Author

I reformatted commit message.

@matkoniecz
Copy link
Contributor Author

I think it should be git config --global --add apply.whitespace fix, as that fixes whitespace when you apply a patch, which is where a collaborator would need it.

It makes sense, given "Please never use GitHub's green "Merge Pull Request" button" in https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md#landing-pull-requests .

@matkoniecz
Copy link
Contributor Author

@gibfahn It is ready for rereview.

@mscdex
Copy link
Contributor

mscdex commented Apr 17, 2017

Minor nit: there's a typo in the commit message (below the first line).

@mscdex mscdex added the meta Issues and PRs related to the general management of the project. label Apr 17, 2017
Old config instruction instructed people to enable option that does not exist and is silently ignored by git
Refs: #11412
@matkoniecz
Copy link
Contributor Author

Minor nit: there's a typo in the commit message (below the first line).

Thanks, should be fixed now.

@matkoniecz matkoniecz changed the title remove recommendation to use useless config fix recommendation to use useless config Apr 17, 2017
@matkoniecz matkoniecz closed this Apr 17, 2017
@matkoniecz matkoniecz reopened this Apr 17, 2017
jasnell pushed a commit that referenced this pull request Apr 18, 2017
Use apply.whitespace=fix rather than core.whitespace=fix

Ref: #11412
PR-URL: #12445
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell jasnell changed the title fix recommendation to use useless config doc: fix recommendation to use useless config Apr 18, 2017
@jasnell
Copy link
Member

jasnell commented Apr 18, 2017

Landed in def78e8 with a modified commit log message.

@jasnell jasnell closed this Apr 18, 2017
@Fishrock123
Copy link
Contributor

@jasnell commit did not link?

@jasnell
Copy link
Member

jasnell commented Apr 18, 2017

That's odd! let's try again with the full hash def78e8
(yeah, short hash did not auto link for some unknown reason)

@gibfahn
Copy link
Member

gibfahn commented Apr 18, 2017

@jasnell yeah I've noticed it not link properly quite a few times, possibly a GitHub issue. I generally just go to https://github.com/nodejs/node and click on the Latest commit link, and then just paste in the full url (i.e. https://github.com/nodejs/node/commit/2519757b800a21c6b93490372841bc58307c46b7), that way you know it worked.

@aqrln
Copy link
Contributor

aqrln commented Apr 18, 2017

Maybe we are starting to be out of seven-character hashes and there was an ambiguity. FWIW, I copy the full commit hash via git rev-parse HEAD | pbcopy on macOS (I believe git rev-parse HEAD | xclip -selection clipboard should do the same on Linux) right after committing to master.

UPD: nope, no ambiguity, that's the only commit to start with def78e8.

@matkoniecz matkoniecz deleted the remove_useless branch April 19, 2017 11:23
evanlucas pushed a commit that referenced this pull request Apr 25, 2017
Use apply.whitespace=fix rather than core.whitespace=fix

Ref: #11412
PR-URL: #12445
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@evanlucas evanlucas mentioned this pull request May 1, 2017
evanlucas pushed a commit that referenced this pull request May 1, 2017
Use apply.whitespace=fix rather than core.whitespace=fix

Ref: #11412
PR-URL: #12445
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
evanlucas pushed a commit that referenced this pull request May 2, 2017
Use apply.whitespace=fix rather than core.whitespace=fix

Ref: #11412
PR-URL: #12445
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
gibfahn pushed a commit that referenced this pull request May 16, 2017
Use apply.whitespace=fix rather than core.whitespace=fix

Ref: #11412
PR-URL: #12445
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request May 18, 2017
Use apply.whitespace=fix rather than core.whitespace=fix

Ref: #11412
PR-URL: #12445
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request May 23, 2017
andrew749 pushed a commit to michielbaird/node that referenced this pull request Jul 19, 2017
Use apply.whitespace=fix rather than core.whitespace=fix

Ref: nodejs/node#11412
PR-URL: nodejs/node#12445
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants