Skip to content

[IGNORE ME]fix(docs): add hwloc and pkg-config installation prerequisites by OS#3143

Open
Standing-Man wants to merge 6 commits intoapache:masterfrom
Standing-Man:update-contribution
Open

[IGNORE ME]fix(docs): add hwloc and pkg-config installation prerequisites by OS#3143
Standing-Man wants to merge 6 commits intoapache:masterfrom
Standing-Man:update-contribution

Conversation

@Standing-Man
Copy link
Copy Markdown
Contributor

@Standing-Man Standing-Man commented Apr 20, 2026

Which issue does this PR close?

Closes #

Rationale

Local builds are prone to failure due to undocumented prerequisites: hwlocality depends on system hwloc, and detection relies on pkg-config/pkgconf, which are not currently documented in CONTRIBUTING.md.

What changed?

Updated CONTRIBUTING.md by adding a new System Dependencies section under Run It Locally that:

  • Explains the server crates depend on hwlocality (hwloc bindings).
  • Clarifies non-musl targets need system hwloc dev packages before build.
  • Adds OS-specific install commands:
    • Ubuntu/Debian: libhwloc-dev pkg-config
    • Fedora/RHEL/CentOS: hwloc-devel pkgconf-pkg-config
    • Arch: hwloc pkgconf
    • macOS (Homebrew): hwloc pkg-config
  • Notes musl targets use vendored hwlocality support in this repo.

Local Execution

  • Passed / not passed
    Passed
  • Pre-commit hooks ran / not ran
    Ran

AI Usage

Signed-off-by: StandingMan <jmtangcs@gmail.com>
@Standing-Man Standing-Man changed the title docs: add hwloc and pkg-config installation prerequisites by OS docs(contributing): add hwloc and pkg-config installation prerequisites by OS Apr 20, 2026
@Standing-Man Standing-Man changed the title docs(contributing): add hwloc and pkg-config installation prerequisites by OS fix(docs): add hwloc and pkg-config installation prerequisites by OS Apr 20, 2026
@Standing-Man
Copy link
Copy Markdown
Contributor Author

Standing-Man commented Apr 20, 2026

Hi @hubcio and @spetz - Please review at your convinience.

@Standing-Man
Copy link
Copy Markdown
Contributor Author

Hi, Please hold off on merging this PR for now. I think CONTRIBUTING.md still needs to include instructions on installing system dependencies and crates, among other details. Thanks!

@Standing-Man Standing-Man changed the title fix(docs): add hwloc and pkg-config installation prerequisites by OS [IGNORE ME]fix(docs): add hwloc and pkg-config installation prerequisites by OS Apr 23, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs.

If you need a review, please ensure CI is green and the PR is rebased on the latest master. Don't hesitate to ping the maintainers - either @core on Discord or by mentioning them directly here on the PR.

Thank you for your contribution!

@github-actions github-actions Bot added the stale Inactive issue or pull request label May 1, 2026
@github-actions github-actions Bot removed the stale Inactive issue or pull request label May 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants