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 important note in Step 2 about how WSL users should use the Linux git #38040

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

Conversation

chrisxu3
Copy link

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation and checked the documentation preview.

⌛ Dependencies

See #37117 #38039 for the details, which are regarding errors that you run into if you're using WSL and don't use Linux git to clone the repo.

README.md Show resolved Hide resolved
@mkoeppe
Copy link
Member

mkoeppe commented May 20, 2024

@chrisxu3 I think our use of -c core.symlinks=true in the instructions is intended to actually make this work also with some types of git in Windows. But I'm not sure which ones. If you have a chance to try this out, this would be very helpful

@@ -153,6 +153,10 @@ in the Installation Guide.

2. Clone the sources with `git`:

- [Windows] **The Sage source tree contains symbolic links, which use UNIX line endings.
Copy link
Member

Choose a reason for hiding this comment

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

"symbolic links" and "UNIX line endings" are two separate, unrelated things

Copy link
Author

Choose a reason for hiding this comment

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

Maybe it should be clarified that it's using Windows line endings that ends up breaking the symlinks?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants