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

Clarify instructions for updating EOL's of repo HEAD #21151

Closed
1 task done
stephenskett opened this issue Oct 6, 2022 · 3 comments · Fixed by #21154
Closed
1 task done

Clarify instructions for updating EOL's of repo HEAD #21151

stephenskett opened this issue Oct 6, 2022 · 3 comments · Fixed by #21154
Labels
content This issue or pull request belongs to the Docs Content team

Comments

@stephenskett
Copy link
Contributor

Code of Conduct

What article on docs.github.com is affected?

"Configuring Git to handle line endings"

What part(s) of the article would you like to see updated?

I feel there is a clarity and/or correctness issue within the sub-section of this page headed "Refreshing a repository after changing line endings".

Specifically:

  • The instructions in the numbered list are somewhat unclear as to what exactly is being accomplished, i.e. will the current checked-out version of files' EOL's in the current repo's HEAD be updated, or just the entries in the Git database?
    (I would assume the former given the section's title.)
  • The line immediately before the numbered instructions seems to imply you need to manually delete/re-add files from the repo dir at some stage, but if so it's not made clear when this should be done, or if not when during the process it is supposed to occur.
  • More importantly, the instruction in point 2 does not work as expected for me when attempting to update the line endings of files in the current repo HEAD for an existing checked-out repo.
    I found an alternative methodology for doing this on Stack Overflow which did work in my case - this thread here, 2nd solution. Would it be possible to add this into the article in some form?
    I am making a pull request with an update to include this in as a possible alternative method under point 2 for my specific use case, but open to suggestions on exact wording!

Additional information

N.B. For my current use case, I am updating the EOL characters in a locally-stored repo, using git version 2.35.1 on Windows, but with the intention to run the code on a Linux system (hence need to force EOL characters to LF).

PR to follow! Thanks.

@stephenskett stephenskett added the content This issue or pull request belongs to the Docs Content team label Oct 6, 2022
@welcome
Copy link

welcome bot commented Oct 6, 2022

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 6, 2022
@steveward steveward removed the triage Do not begin working on this issue until triaged by the team label Oct 7, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Dec 6, 2022

A stale label has been added to this issue becuase it has been open for 60 days with no activity. To keep this issue open, add a comment within 3 days.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Dec 6, 2022
@cmwilson21 cmwilson21 removed the stale There is no recent activity on this issue or pull request label Dec 7, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2023

A stale label has been added to this issue becuase it has been open for 60 days with no activity. To keep this issue open, add a comment within 3 days.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Feb 5, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Feb 6, 2023
@cmwilson21 cmwilson21 removed the stale There is no recent activity on this issue or pull request label Feb 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants