-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Refactor build instructions #4381
Conversation
FWIW, I personally do not use the It seems like preserving information on installing rippled would be worthwhile, but I have no opinion on where such documentation should live. Similarly, instructions on how to depend on the xrpl-core library seem useful, but I have no opinion on where those instructions should live. |
I suggest that one way to port and preserve the documentation that might still be useful would be move it to a |
I have been using I think if you look at the history, the |
Well, |
With Conan, static vs shared linkage is selected per-dependency with a Boolean option that every Conan package conventionally calls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see any issues with removing these files that haven't already been noted in the PR
I have added some changes that refactor the build instructions based on the plan I laid out in #4433. The only part missing here from that plan is the dependency instructions, which I plan to add in a separate PR along with the Conan recipe I pitched in #4443. If these changes are merged, I have a few requests:
|
@thejohnfreeman from your perspective, is this PR ready to merge now? |
No, the reviews should have been invalidated. |
GitHub will not let me request a review from @oeggert for some reason. I cannot even autocomplete a tag for him in my comments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. I'll update #4423 with this new structure in mind.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@thejohnfreeman confirmed this is good to merge now. I don't see any risky changes, and any changes/fixes can be easily proposed in a follow-up PR.
This is a blanket removal of the build instructions at
Builds/{VisualStudio2019,macos,linux}
. Most of these instructions are obsolete, e.g. installing dependencies. There are a few notable exceptions that I want to discuss how to handle.jemalloc
orstatic
options toBUILD.md
. I do not believe thatjemalloc
is used by anyone. I think it was only used by @mtrippled, and that he doesn't use it any more. Please correct me if I'm wrong on that. I'm not aware of anyone who turns thestatic
optionOFF
(its default isON
), and supporting theOFF
value would require us to changeconanfile.py
anyway, to propagate that choice to theshared
option of the affected dependencies. I do not believe this option is appropriate to have in our project anyway. By using Conan, we can let builders choose which dependencies specifically to build and link as shared objects. I prefer that we remove both of these options. Objections?BUILD.md
. Suggestions?