Repository navigation
docs(hipfile) adding docs info on p2pdma support on linux kernels - #13756
Conversation
github-actions
Bot
added
documentation
✅ All Policy Checks Passed
📖 Need help? See the Policy FAQ for details on every check and how to fix failures. |
|
/docs-preview |
|
Docs preview for hipfile is building on Read the Docs: https://rocm.docs.amd.com/projects/hipFile/en/users-akolliasamd-p2pdmaupdatev2/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.) |
There was a problem hiding this comment.
🟡 Changes recommended
The guidance incorrectly treats a PCIe-specific requirement as universal and guarantees fallback even when it is disabled.
2 open issues
What changed in this PR
This documentation-only PR explains hipFile’s kernel P2PDMA requirements and helps users diagnose unavailable fastpath support.
Changes:
- Adds kernel checks and Ubuntu HWE installation guidance.
- Introduces a kernel support matrix with VM test results.
- Links the guidance throughout installation and troubleshooting documentation.
| File | Description |
|---|---|
| projects/hipfile/docs/troubleshooting/troubleshooting.rst | Adds P2PDMA diagnostics. |
| projects/hipfile/docs/troubleshooting/limitations.rst | Documents kernel requirements. |
| projects/hipfile/docs/troubleshooting/known-issues.rst | Describes Ubuntu’s default-kernel limitation and workaround. |
| projects/hipfile/docs/sphinx/_toc.yml.in | Adds matrix navigation. |
| projects/hipfile/docs/reference/hipFile-kernel-support-matrix.rst | Records tested kernels and VM results. |
| projects/hipfile/docs/install/install.rst | Adds kernel checks and upgrade instructions. |
| projects/hipfile/docs/install/build-from-source.rst | Clarifies fastpath prerequisites. |
| projects/hipfile/docs/how-to/checking-system-compatibility.rst | Explains capability detection and diagnostic results. |
| projects/hipfile/CHANGELOG.md | Records the documentation update. |
Review effort: Balanced
|
/docs-preview |
|
Docs preview for hipfile is building on Read the Docs: https://rocm.docs.amd.com/projects/hipFile/en/users-akolliasamd-p2pdmaupdatev2/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.) |
|
/docs-preview |
|
Docs preview for hipfile is building on Read the Docs: https://rocm.docs.amd.com/projects/hipFile/en/users-akolliasamd-p2pdmaupdatev2/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.) |
|
/docs-preview |
|
Docs preview for hipfile is building on Read the Docs: https://rocm.docs.amd.com/projects/hipFile/en/users-akolliasamd-p2pdmaupdatev2/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.) |
|
/docs-preview |
|
Docs preview for hipfile is building on Read the Docs: https://rocm.docs.amd.com/projects/hipFile/en/users-akolliasamd-p2pdmaupdatev2/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.) |
|
The links to readthedocs are apppearing randomly. Here is the link to the latest build: |
54280db to
ed95093
Compare
|
/docs-preview |
|
Docs preview for hipfile is building on Read the Docs: https://rocm.docs.amd.com/projects/hipFile/en/users-akolliasamd-p2pdmaupdatev2/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.) |
ed95093 to
6d9319c
Compare
TheRock Submodule Bump ActivityNewest first
|
Motivation
The p2pdma requirement for hipfile needs more documentation (copy of 12662 PR for building docs)
Technical Details
N/A
Issue Tracking
JIRA ID : AIHIPFILE-278
Test Plan
Test Result
Submission Checklist