Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Documentation improvement for macOS Homebrew libomp installation #31359

Copy link
Copy link
Open
@ParthS007

Description

@ParthS007
Issue body actions

Describe the issue linked to the documentation

The current documentation in doc/developers/advanced_installation.rst under the "macOS compilers from Homebrew" section provides environment variable examples using the path /usr/local/opt/libomp/. While this is correct for Intel-based Macs, Homebrew on Apple Silicon (arm64) Macs installs packages, including libomp, to /opt/homebrew/opt/libomp/.

This can lead to confusion and build issues for users on Apple Silicon hardware who follow the documentation to install from source.

The documentation will improve from mentioning that libomp is often installed as "keg-only" by Homebrew, which is why explicitly setting these paths is necessary. Homebrew's own output (brew info libomp) often provides guidance on the necessary CPPFLAGS and LDFLAGS.

Suggest a potential alternative/fix

The documentation could be updated to:

  1. Mention the different Homebrew base paths for Intel (/usr/local) and Apple Silicon (/opt/homebrew).
  2. Update the example environment variable settings to reflect the /opt/homebrew/opt/libomp path as a common case for Apple Silicon, or provide instructions for users to identify and use the correct path for their system.
  3. Optionally, We could briefly explain the "keg-only" nature of libomp from Homebrew and how it relates to needing these environment variables.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    Morty Proxy This is a proxified and sanitized view of the page, visit original site.