Conversation
derobins
requested review from
gaoikawa,
jordan-turbofish,
kurtmcmillan,
riley-dixon and
zbyrne
as code owners
There was a problem hiding this comment.
Pull request overview
Updates the installation documentation to reflect current platform/filesystem support and build-time dependency requirements for hipFile.
Changes:
- Document xfs as a supported filesystem alongside ext4.
- Replace the previous ROCm “unreleased” note with an explicit prerequisites list (CMake/C++/ROCm/amdgpu/Boost/libmount).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * Boost | ||
| * libmount |
There was a problem hiding this comment.
In the prerequisites list, Boost and libmount read like runtime packages, but building this project (and tests) needs the development headers/libraries (e.g., libmount-dev/libmount-devel and Boost program_options dev packages). Suggest clarifying that these are -dev/-devel dependencies (and optionally which Boost component is required) to prevent install/build failures.
| * Boost | |
| * libmount | |
| * Boost development packages (including `program_options`; e.g. `libboost-program-options-dev` / `boost-devel`) | |
| * libmount development packages (e.g. `libmount-dev` / `libmount-devel`) |
| * CMake >= 3.21 | ||
| * C++ >= 17 (tested w/ clang++ & g++, we don't use GNU extensions) | ||
| * ROCm >= 7.2 | ||
| * amdgpu >= 30.10.1 |
There was a problem hiding this comment.
The prerequisite amdgpu >= 30.10.1 is ambiguous (kernel module vs. the amdgpu-dkms/driver package) and doesn’t match the earlier wording that refers to amdgpu-dkms. Consider renaming this to the actual installable package/driver requirement (and, if relevant, noting how to check the version) so readers know what to install/verify.
| * amdgpu >= 30.10.1 | |
| * amdgpu-dkms >= 30.10.1 |
| * CMake >= 3.21 | ||
| * C++ >= 17 (tested w/ clang++ & g++, we don't use GNU extensions) | ||
| * ROCm >= 7.2 | ||
| * amdgpu >= 30.10.1 |
There was a problem hiding this comment.
30.20.1 should be the minimum version. (Also agree with copilot about specifying dkms).
| @@ -80,7 +80,7 @@ If CMake can't find hipcc/nvcc, you can set `-DCMAKE_HIP_COMPILER=<path>` | |||
|
|
|||
| Supported platforms: Linux (Windows may be supported in a future release) | |||
There was a problem hiding this comment.
Could you add something to the effect that in the linux kernel we require 'CONFIG_PCI_P2PDMA' to be enabled? On by default in Ubuntu 24.04 (is this true?), but not in 22.x? Can be done in Ubuntu22 via the hardware enablement kernel (hwe)? (Need to confirm.) Would be good if we could give some guidance on what has it enabled by default and what doesn't, and either a link to existing instructions for a few distros.
derobins
force-pushed
the
derobins/install_update
branch
from
5fd4897 to
4afad86
Compare
No description provided.