Add a migration guide for the ROCm-packaged Fortran bindings - #548
Draft
amontoison wants to merge 1 commit into
Draft
amontoison wants to merge 1 commit into
amontoison wants to merge 1 commit into
Conversation
Document the move from hipFORT to the bindings that ship inside ROCm (rocm-systems and rocm-libraries), in the spirit of the layout previewed in #540: one self-contained module per library, ROCm only. The guide covers the two edits a consumer has to make (the `use` statement rename, with a sed recipe and the cases it deliberately leaves to review; and the per-library Fortran archive and CMake target), the build options, the per-compiler install layout and how to rebuild a binding for a non-amdflang compiler, what does not change, and an FAQ covering the old/new coexistence. Wire the page into the docs index and the Sphinx TOC.
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.
Adds
docs/how-to/migration-guide.rst, a how-to for users moving from hipFORT to the Fortran bindings that ship inside ROCm (rocm-systemsandrocm-libraries), in the spirit of the layout previewed in #540: one self-contained module per library, ROCm only.What the page covers
usestatements (use hipfort_rocblasbecomesuse rocblas, helper modules folded in), and link the per-library Fortran archive (find_package(rocblas)givesroc::rocblas_fortran). Both as tables, plus asedrecipe for the rename and an explicit list of the cases it deliberately leaves to review (twouse hiplines, files that used onlyhipfort_check,roctxandcuda_errors, fixed form, preprocessor guards).BUILD_FORTRAN_BINDINGS,BUILD_FORTRAN_TESTS, and the tri-stateFORTRAN_ARRAY_INTERFACESthat replacesHIPFORT_USE_FPOINTER_INTERFACESplusHIPFORT_ASSUMED_RANK, with a table mapping everyHIPFORT_*option to its successor..modis compiler- and version-specific, the per-compiler install layout, raw link lines for amdflang and gfortran, and how to rebuild one library's binding from source without rebuilding the C library.Also wires the page into
docs/index.rstanddocs/sphinx/_toc.yml.inunder How to.Status
Draft. The page states a ROCm 10.2 / 11.0 timeline and several conventions that are settled in the design document but not yet implemented in
rocm-systems/rocm-libraries, so the content should be reviewed against whatever actually lands there.--> Preview <--