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.

Sign up for GitHub

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

Jump to bottom

Add note on handling line endings for Windows users #781

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

Add note on handling line endings for Windows users #781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3248262
Add note on handling line endings for Windows and WSL users
JuliaNortman Jun 6, 2024
29b78ea
Update contributors list
JuliaNortman Jun 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/manual/contributors.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,4 +143,5 @@
Weilan Tao,
Weitian Xing,
Werner Dietl,
Yuliia Nortman,
Zhiping Cai.
4 changes: 4 additions & 0 deletions docs/manual/troubleshooting.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -822,6 +822,10 @@
You might want to add an \<export CHECKERFRAMEWORK=...> line to your
\<.bashrc> file.

\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.
Comment on lines +825 to +828
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?


\subsectionAndLabel{Build the Checker Framework}{building}

Expand Down
Loading