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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 27, 2024
Merged

Add Java requirement to install guide #2621

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11045b9
Add Java requirement to install guide
LeStarch Mar 26, 2024
4d9e5e4
Change Java to a note
LeStarch Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Collaborator

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.

  1. 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´

Copy link
Contributor

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.

Copy link
Collaborator

@thomas-bc thomas-bc Mar 26, 2024 •
edited
Loading

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.

Copy link
Collaborator Author

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.


> Latest versions of PIP are strongly recommended, as this will install native packages with improved performance and no dependency on Java. See [Recommended PIP Versions](#recommended-pip-versions)

Expand Down
Loading