-
Notifications
You must be signed in to change notification settings - Fork 30k
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: update the Troubleshooting section of the Collaborator Guide #26652
Conversation
In the Troubleshooting portion of the Collaborator Guide, there is a copy/pasted error message. The message is out of date. More recent git contains a more concise and clear message. Update the text to reflect the current git error message.
In the Troubleshooting section of the Collaborator Guide, there is one particularly lengthy and difficult-to-understand sentence. Make it shorter and more clear.
(Change to the git |
hint: to the same ref. You may want to first integrate the remote changes | ||
hint: (e.g. 'git pull ...') before pushing again. | ||
hint: Updates were rejected because the tip of your current branch is behind | ||
hint: its remote counterpart. Integrate the remote changes (e.g. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new description is definitely on the point and correct but the former one seems easier to understand or at least to me, it seems the former version required less knowledge about git. I personally would stick to the former version for the first sentence.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about just removing all the hint
text and leaving lines 603-605? That's the relevant part anyway. The hint text will be whatever and we don't control it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at it again: I just realized this is 1-to-1 the actual git hint. Therefore it's probably indeed good to use that.
Landed in 5a23a87...22de2cf |
In the Troubleshooting portion of the Collaborator Guide, there is a copy/pasted error message. The message is out of date. More recent git contains a more concise and clear message. Update the text to reflect the current git error message. PR-URL: nodejs#26652 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
In the Troubleshooting section of the Collaborator Guide, there is one particularly lengthy and difficult-to-understand sentence. Make it shorter and more clear. PR-URL: nodejs#26652 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
In the Troubleshooting portion of the Collaborator Guide, there is a copy/pasted error message. The message is out of date. More recent git contains a more concise and clear message. Update the text to reflect the current git error message. PR-URL: nodejs#26652 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
In the Troubleshooting section of the Collaborator Guide, there is one particularly lengthy and difficult-to-understand sentence. Make it shorter and more clear. PR-URL: nodejs#26652 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
In the Troubleshooting portion of the Collaborator Guide, there is a copy/pasted error message. The message is out of date. More recent git contains a more concise and clear message. Update the text to reflect the current git error message. PR-URL: #26652 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
In the Troubleshooting section of the Collaborator Guide, there is one particularly lengthy and difficult-to-understand sentence. Make it shorter and more clear. PR-URL: #26652 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
In the Troubleshooting portion of the Collaborator Guide, there is a copy/pasted error message. The message is out of date. More recent git contains a more concise and clear message. Update the text to reflect the current git error message. PR-URL: #26652 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
In the Troubleshooting section of the Collaborator Guide, there is one particularly lengthy and difficult-to-understand sentence. Make it shorter and more clear. PR-URL: #26652 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
Some changes to keep things simple and direct.
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes