Skip to content

Commit

Permalink
Update Homebrew Java installation docs for OSX (#14729)
Browse files Browse the repository at this point in the history
## Change Description

When going through the [documentation for installing Hail on
OSX](https://hail.is/docs/0.2/install/macosx.html), I noticed that the
syntax for installing Java via Homebrew was out of date.

This PR updates the documentation to use the latest syntax for Homebrew.
It also updates the command to install version 11 of Temurin instead of
version 8.

## Security Assessment

- This change has no security impact

### Impact Description

This change updates documentation only and has no immediate end user
impact.

This change updates the recommended version of Temurin to a newer
version (11 vs. 8). It is reasonable to assume that the newer version is
at least as secure as previous versions. So, there also should be no
negative security impact on future users of this documentation.
  • Loading branch information
kasittig authored Dec 10, 2024
1 parent 1ede2f1 commit ea00578
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions hail/python/hail/docs/install/macosx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@
Install Hail on Mac OS X
========================

- Install Java 11. We recommend using a `packaged installation from Azul
<https://www.azul.com/downloads/?version=java-11-lts&os=macos&package=jdk&show-old-builds=true>`__
- Install Java 11. We recommend using a `packaged installation from Temurin
<https://adoptium.net/temurin/releases/?os=mac&arch=arm&version=11>`__
(make sure the OS version and architecture match your system) or using `Homebrew
<https://brew.sh/>`__:

.. code-block::
brew tap homebrew/cask-versions
brew install --cask temurin8
brew install temurin@11
You *must* pick a Java installation with a compatible architecture. If you have an Apple M1 or M2
You *must* pick a Java 11 installation with a compatible architecture. If your processor uses Apple M-series silicon
you must use an "arm64" Java, otherwise you must use an "x86_64" Java. You can check if you have
an M1 or M2 either in the "Apple Menu > About This Mac" or by running ``uname -m`` Terminal.app.

Expand Down

0 comments on commit ea00578

Please sign in to comment.