[jordan-turbofish]

Motivation

Remove warnings from batch documentation.
Remove mentions of async not supporting fastpath.
Some comment fixes.
Add :members: to doxygen groups so that structs are documented.

Technical Details

Issue Tracking

JIRA ID: AIHIPFILE-232

Test Plan

Test Result

Submission Checklist

• Look over the contributing guidelines at https://github.com/ROCm/rocm-systems/blob/develop/CONTRIBUTING.md.

[therock-pr-bot]

✅ All Policy Checks Passed

Check	Status	Details
📝 PR Description	✅ Pass	—
⛔ Forbidden Files	✅ Pass	—
🧪 Unit Test	⚠️ Warning	Error: Source/code files changed without an accompanying unit test. Expected: add at least one test file named like test_<name>.py / test_<name>.cpp (or <name>_test.*). Current: code file(s) changed: projects/hipfile/include/hipfile.h; no test file found
🚫 Draft PR	🔜 To Be Enabled	—
🚩 Feature Flag	🔜 To Be Enabled	—
📊 Code Coverage	🔜 To Be Enabled	—

🎉 All policy checks passed!

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

🙋 Wish to Override Policy?

[therock-pr-bot]

🚫 Please fix the failed policies before requesting reviews.

The following policy checks failed:

• ❌ PR Description

The Not ready to Review label has been added to this PR.
Once all policies pass, the label will be removed automatically.

[jordan-turbofish]

/docs-preview

[systems-assistant]

Docs preview for hipfile is building on Read the Docs: https://rocm.docs.amd.com/projects/hipFile/en/users-jpatters-batch-doc-update-1/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.)

[jordan-turbofish]

/docs-preview

[systems-assistant]

Docs preview for hipfile is building on Read the Docs: https://rocm.docs.amd.com/projects/hipFile/en/users-jpatters-batch-doc-update-1/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.)

[jordan-turbofish]

/docs-preview

[systems-assistant]

Docs preview for hipfile is building on Read the Docs: https://rocm.docs.amd.com/projects/hipFile/en/users-jpatters-batch-doc-update-1/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.)

[jordan-turbofish]

/docs-preview

[systems-assistant]

Docs preview for hipfile is building on Read the Docs: https://rocm.docs.amd.com/projects/hipFile/en/users-jpatters-batch-doc-update-1/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.)

[Copilot]

🟡 Changes recommended

The new known-issues entry is misleading about fastpath prerequisites and uses inconsistent “P2PDMA” acronym casing, which should be corrected for accurate user guidance.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Updates hipFile’s documentation to remove outdated “not implemented”/backend limitation warnings and to improve the generated API reference output.

Changes:

• Refresh batch API docs (header comments + reference page) to reflect current implementation status and clarify batch handle sizing limits.
• Remove outdated guidance stating async I/O can’t use fastpath, and add a new known-issue entry describing async fastpath fallback behavior.
• Update multiple API reference pages to include group members in the rendered docs (:members:).

File summaries

File	Description
projects/hipfile/include/hipfile.h	Updates batch API Doxygen comments (batch setup wording; removes “not implemented” warnings).
projects/hipfile/examples/README.md	Removes outdated note about async always using fallback path.
projects/hipfile/docs/tutorials/async-multistream-io.rst	Removes outdated note about async fastpath not being supported.
projects/hipfile/docs/troubleshooting/known-issues.rst	Adds a new known-issue describing async fastpath not retrying on fallback.
projects/hipfile/docs/reference/api-synchronous-io.rst	Enables :members: for the sync Doxygen group output.
projects/hipfile/docs/reference/api-file-and-buffer.rst	Enables :members: for the file Doxygen group output.
projects/hipfile/docs/reference/api-errors.rst	Enables :members: for the error Doxygen group output.
projects/hipfile/docs/reference/api-driver.rst	Enables :members: for the driver and core Doxygen group output.
projects/hipfile/docs/reference/api-batch.rst	Removes a warning block and enables :members: for the batch Doxygen group output.
projects/hipfile/docs/reference/api-async.rst	Removes outdated backend limitation text in the async API reference introduction.

Review details

• Files reviewed: 10/10 changed files
• Comments generated: 1
• Review effort level: Lite

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[jordan-turbofish]

/docs-preview

[systems-assistant]

Docs preview for hipfile is building on Read the Docs: https://rocm.docs.amd.com/projects/hipFile/en/users-jpatters-batch-doc-update-1/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.)

[systems-assistant]

TheRock Submodule Bump Activity

Newest first

• 2026-09-08 — Included in TheRock via ROCm/TheRock#7974.