The current documentation has multiple issues:
pycapnp module.python3-zmq is a package name in some Linux distros, rather than a Unix-wide convention.pyzmq from PyPI works in general, not only on macOS.lsof dependency is undocumented.This PR resolves these issues. Additionally, two minor improvements have been added (see commit messages).
Additionally, switch the example code to PowerShell to match our other
Windows docs.
The current documentation has multiple issues:
1. OS-specific notes are missing for the `pycapnp` module.
2. `python3-zmq` is a package name in some Linux distros, rather than a
Unix-wide convention.
3. Installing `pyzmq` from PyPI works in general, not only on macOS.
Resolve these issues by consolidating and fixing the documentation.
<!--e57a25ab6845829454e8d69fc972939a-->
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
<!--006a51241073e994b41acfe9ec718e94-->
For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/35395.
<!--021abf342d371248e50ceaed478a90ca-->
See the guideline for information on the review process. A summary of reviews will appear here.
<!--5faf32d7da4f0f540f40219e4f7537a3-->
Looks like you've just removed immediately usable OS specific instructions, and replaced them with general ones, just forcing devs to go and find the same info? i.e currently a FreeBSD dev could just copy pkg install python3 databases/py-sqlite3 net/py-pyzmq, now they'd have to go and find the package names themselves?
Looks like you've just removed immediately usable OS specific instructions, and replaced them with general ones, just forcing devs to go and find the same info? i.e currently a FreeBSD dev could just copy
pkg install python3 databases/py-sqlite3 net/py-pyzmq, now they'd have to go and find the package names themselves?
That's correct, it is a trade-off. While it does require a quick search from the developer, the alternative is duplicating every dependency instruction across all OS-specific notes, e.g., pkg install lsof or pip3 install pycapnp. As we saw with recent updates (#33201 and #34256), trying to maintain exact, OS-specific package names quickly becomes a fragile approach.
trying to maintain exact, OS-specific package names quickly becomes a fragile approach.
Not sure I agree. That's what we do in the rest of the build documentation, and it seems to work fine.
I haven't looked, but are the bsd docs largely different? if not, maybe they can be merged into a single build-bsd.md in the style of build-unix.md from #35402?
Going further, maybe we can just merge build-bsd.md and build-unix.md into a single build.md (and only keep build-osx and build-windows), or possibly merge even them into a separate section in a general build.md file?