-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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 Java requirement to install guide #2621
Conversation
docs/INSTALL.md
Outdated
@@ -27,6 +27,7 @@ Requirements: | |||
3. [CMake 3.16](https://cmake.org/download/) or newer. CLI tool must be available on the system path. | |||
4. CLang or GNU C and C++ compilers (e.g. gcc and g++) | |||
5. [Python 3.8+](https://www.python.org/downloads/), virtual environments, and PIP | |||
6. Java for build machine architectures other than x86_64 and aarch64 |
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.
Any way we can format this to be less scary at first glance?
e.g.
- For build host architectures other than x86_64 aarch64, Java is required to run the FPP tools
Or (better in my opinion) make it a note
Note: For build host architectures other than x86_64 aarch64, Java is required to run the FPP tools
Or anything really. Just trying not to make a 10second-read of this page mislead people in believing Java is a requirement for F´
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.
Practically speaking, is anybody actually trying to build fprime on something other than x86_64/aarch64 systems?
Maybe an old 32-bit raspberry pi OS? Can't imagine too many people are using PPC or RISC.
I might just say that fprime only supports development on x86_64/aarch64 systems.
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.
@Joshua-Anderson yeah I agree with you, that's why I wouldn't really want to have a big bold "JAVA" requirement in the install guide.
But we did have one customer that was trying to build on something else, and not having Java installed caused an issue which wasn't as quickly identifiable as it should have been (corrected in #2620). Since we do have a better error handling now, I'm hesitant to add it as an entry in the system requirements as well.
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.
Java is required for RISC-V. The current recommendations for cross-compiling RISC-V is to compile in an emulated RISC-V machine. I like @thomas-bc's suggestion of a note. I will make that change.
Change Description
Fix install guide to include Java for non-x86_64/aarch64 systems.