Standing-Man opened a new pull request, #3143:
URL: https://github.com/apache/iggy/pull/3143
## Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements. You can link an issue to this PR using the GitHub syntax. For
example `Closes #123` indicates that this PR will close issue #123.
-->
Closes #
## Rationale
<!--
Why is this change needed? If the issue explains it well, a one-liner is
fine.
-->
Some contributors can’t build locally because hwlocality requires system
hwloc, and detection commonly depends on pkg-config/pkgconf. The previous
CONTRIBUTING.md did not document these prerequisites, which led to avoidable
setup failures.
## What changed?
<!--
2-4 sentences. Problem first (before), then solution (after).
GOOD:
"Messages were unavailable when background message_saver committed the
journal and started async disk I/O before completion. Polling during
this window found neither journal nor disk data.
The fix freezes journal batches in the in-flight buffer before async
persist."
GOOD:
"When many small messages accumulate in the journal, the flush passes
thousands of IO vectors to writev(), exceeding IOV_MAX (1024 on Linux)."
BAD:
- Walls of text
- "This PR adds..." (we can see the diff)
-->
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
<!--
You must run your code locally before submitting.
"Relying on CI" is not acceptable - PRs from authors who haven't run the
code will be closed.
Did you have `prek` installed? It runs automatically on commit and covers
all project languages. See
[CONTRIBUTING.md](https://github.com/apache/iggy/blob/master/CONTRIBUTING.md).
-->
## AI Usage
<!--
If AI tools were used, please answer:
1. Which tools? (e.g., GitHub Copilot, Claude, ChatGPT)
2. Scope of usage? (e.g., autocomplete, generated functions, entire
implementation)
3. How did you verify the generated code works correctly?
4. Can you explain every line of the code if asked?
If no AI tools were used, write "None" or delete this section.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
