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

Add note on handling line endings for Windows users #781

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

JuliaNortman
Copy link

No description provided.

@Ao-senXiong
Copy link
Member

@JuliaNortman Could you add your name to contributor to /docs/manual/contributors.tex

Please see the CI message as suggestion on how to do it. https://dev.azure.com/eisop/checker-framework/_build/results?buildId=5001&view=logs&jobId=c326031a-fc8d-5e8e-5aaf-1127ae89918f&j=c326031a-fc8d-5e8e-5aaf-1127ae89918f&t=56a01ac5-ee6c-5ec2-e15f-d6c913c7703c

@Ao-senXiong Ao-senXiong requested a review from wmdietl June 8, 2024 00:22
Comment on lines +825 to +828
\textbf{Ensure Line Endings are Handled Properly}: Run
\texttt{git config --global core.autocrlf true} in Git Bash to prevent line ending
issues between Windows and Unix-based systems, or execute Git commands directly
from the Ubuntu terminal.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
\textbf{Ensure Line Endings are Handled Properly}: Run
\texttt{git config --global core.autocrlf true} in Git Bash to prevent line ending
issues between Windows and Unix-based systems, or execute Git commands directly
from the Ubuntu terminal.
\textbf{Ensure line endings are handled properly}: Run
\code{git config --global core.autocrlf true} to prevent line ending issues between
Windows and Unix-based systems.

Copy link
Member

Choose a reason for hiding this comment

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

The Ubuntu terminal part is too distribution specific. Maybe there should be a general note about how to build on Windows/Unix?

Copy link
Member

@wmdietl wmdietl left a comment

Choose a reason for hiding this comment

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

Thanks!

Comment on lines +825 to +828
\textbf{Ensure Line Endings are Handled Properly}: Run
\texttt{git config --global core.autocrlf true} in Git Bash to prevent line ending
issues between Windows and Unix-based systems, or execute Git commands directly
from the Ubuntu terminal.
Copy link
Member

Choose a reason for hiding this comment

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

The Ubuntu terminal part is too distribution specific. Maybe there should be a general note about how to build on Windows/Unix?

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.

None yet

3 participants