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

Adding documentation for building from current master without cloning. #1455

Merged
merged 2 commits into from
Jan 23, 2018

Conversation

devin-petersohn
Copy link
Member

It might be useful for downstream projects to build from the current master without having to clone. This additional doc explains how.

@AmplabJenkins
Copy link

Merged build finished. Test PASSed.

@AmplabJenkins
Copy link

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/3362/
Test PASSed.

@robertnishihara
Copy link
Collaborator

The documentation looks good to me.

Do you find it useful to do this? In the past I feel like I've seen pip install hang when trying to install from GitHub (or error messages would be suppressed if you don't have some dependency like cmake installed or things like that).

Maybe add a note indicating that this approach may be less reliable? If you think it's reliable enough then no need to.

@robertnishihara
Copy link
Collaborator

Note that I just ran this on my mac and it worked fine (though it took a little while). However, I already have all of the relevant dependencies installed and I'm not sure about the behavior when you don't have them installed.

@devin-petersohn
Copy link
Member Author

It does give you the error when it fails. I have had a couple of people try it without having the brew dependencies, and it gives you the failure stack. We could add a note saying that it still requires the dependencies above.

I don't think it takes any longer than building from source normally does, this is just nicer for building downstream apps.

@robertnishihara
Copy link
Collaborator

Ok then I think it's good as is, thanks!

@robertnishihara robertnishihara merged commit 21a9160 into ray-project:master Jan 23, 2018
@robertnishihara
Copy link
Collaborator

Went ahead and merged it. Since it only changes the documentation, it's probably enough for the linting to pass (the linting tries to build the documentation).

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.

3 participants