Consolidate docs in hipfile/docs#94
Merged
Merged
Conversation
Prep for rocFile removal
Contributor
There was a problem hiding this comment.
Pull request overview
This PR consolidates documentation from rocfile/docs into hipfile/docs in preparation for removing rocFile. Documentation files are being deleted from the rocFile directory and either moved or updated in the hipFile directory to reflect the hipFile API naming conventions.
Key Changes:
- Removed all documentation files from
rocfile/docs - Added/updated hipFile documentation with consistent API naming
- Replaced "rocFile" references with "hipFile" throughout the documentation
Reviewed changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| rocfile/docs/rdma.rst | Deleted RDMA documentation from rocFile |
| rocfile/docs/nvidia_compat.rst | Deleted NVIDIA compatibility documentation from rocFile |
| rocfile/docs/introduction.rst | Deleted introduction documentation from rocFile |
| rocfile/docs/file.rst | Deleted file handle API documentation from rocFile |
| rocfile/docs/core.rst | Deleted core API documentation from rocFile |
| rocfile/docs/config_build.rst | Deleted configuration/build documentation from rocFile |
| hipfile/docs/rdma.rst | Added RDMA documentation for hipFile |
| hipfile/docs/introduction.rst | Updated introduction with comprehensive content for hipFile |
| hipfile/docs/file.rst | Added file handle API documentation for hipFile |
| hipfile/docs/errors.rst | Updated all API references from rocFile to hipFile |
| hipfile/docs/driver.rst | Updated all API references from rocFile to hipFile with one typo |
| hipfile/docs/core.rst | Added parameter getters/setters section to hipFile core documentation |
| hipfile/docs/batch.rst | Updated API reference from rocFile to hipFile |
| hipfile/docs/async.rst | Updated API reference from rocFile to hipFile |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kurtmcmillan
approved these changes
Nov 25, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prep for rocFile removal