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

Update the README #1420

Merged
merged 1 commit into from
Jun 20, 2021
Merged

Update the README #1420

merged 1 commit into from
Jun 20, 2021

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Jun 12, 2021

  • Add FAQ about developing outside of linux
  • Clean up confusing terminology around docker-compose
  • Remove outdated link to "developing without docker-compose"

Closes #1395 ("fixes" is probably a stretch).

@nolash does this clear up some confusion?

README.md Outdated Show resolved Hide resolved
- Add FAQ about developing outside of linux
- Clean up confusing terminology around docker-compose
- Remove outdated link to "developing without docker-compose"

You probably have [CRLF line endings](https://en.wikipedia.org/wiki/CRLF).
This causes the hashbang in the docker-entrypoint to be `/bin/sh\r` instead of `/bin/sh`.
This is probably because you have `git.autocrlf` set to true,
[set it to `input`](https://stackoverflow.com/questions/10418975) instead.

##### I see the error `/opt/rustwide/cargo-home/bin/cargo: cannot execute binary file: Exec format error` when running builds.

You are most likely not on a Linux platform. Currently, running builds is only supported on `x86_64-unknown-linux-gnu`.
Copy link
Member

Choose a reason for hiding this comment

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

we could add what running builds is possible through the web container :)

( I'm happy to add it myself after this)

@syphar
Copy link
Member

syphar commented Jun 19, 2021

@jyn514 just saw this is open,

is this ready for review? Or missing something?

@jyn514
Copy link
Member Author

jyn514 commented Jun 19, 2021

@syphar yes, this is ready for review - feel free to merge if it looks good :)

@syphar syphar added the S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed label Jun 20, 2021
@syphar
Copy link
Member

syphar commented Jun 20, 2021

I have some additional ideas regarding running builds on non-linux systems, but will add them separately.

@syphar syphar merged commit 7b80116 into rust-lang:master Jun 20, 2021
@jyn514 jyn514 deleted the update-readme branch June 20, 2021 21:55
@jyn514
Copy link
Member Author

jyn514 commented Jun 20, 2021

@syphar I don't think it will be possible without docker-compose without first fixing rust-lang/rustwide#41

@syphar
Copy link
Member

syphar commented Jun 21, 2021

@syphar I don't think it will be possible without docker-compose without first fixing rust-lang/rustwide#41

that I know,
but when I started I didn't directly know that I can use the web container to run the builds on my mac. So having that in the readme would have helped me :)

@nolash
Copy link

nolash commented Jul 1, 2021

@jyn514 yeah I guess it clears it up to the extent that I am forced to use docker-compose - which kinda sucks ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Possibly stale docs for building without docker-compose
3 participants