Skip to content

Commit 1a3e8c8

Browse files
authored
Reflect upcoming hipfc deprecation (#203)
1 parent 50a1d08 commit 1a3e8c8

File tree

2 files changed

+21
-32
lines changed

2 files changed

+21
-32
lines changed

docs/install/install.rst

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,16 @@ Prerequisites
1515
Building and testing hipFORT from source
1616
==========================================
1717

18-
1. Ensure `gfortran`, `git`, `cmake`, and HIP are installed.
18+
1. Ensure you have ``gfortran``, ``git``, ``cmake``, and HIP installed.
1919
2. Build, install, and test hipFORT from source with the following commands:
2020

21-
.. code-block::
22-
23-
git clone https://github.com/ROCmSoftwarePlatform/hipfort
24-
mkdir build ; cd build
25-
cmake -DHIPFORT_INSTALL_DIR=/tmp/hipfort ..
26-
make install
27-
export PATH=/tmp/hipfort/bin:$PATH
28-
cd ../test/f2003/vecadd
29-
hipfc -v hip_implementation.cpp main.f03
30-
./a.out
31-
32-
21+
.. code-block::
3322
34-
.. note::
35-
36-
The preceding steps demonstrate the `hipfc` utility. `hipfc` calls `hipcc` for non-Fortran files and then compiles the Fortran files and links to the object file created by `hipcc`.
23+
git clone https://github.com/ROCm/hipfort.git
24+
cd hipfort
25+
cmake -S. -Bbuild -DHIPFORT_INSTALL_DIR=/tmp/hipfort -DBUILD_TESTING=ON
26+
make -C build
27+
make -C build check
3728
3829
Fortran interfaces
3930
===================
@@ -134,6 +125,13 @@ hipfc wrapper compiler and Makefile.hipfort
134125

135126
Aside from Fortran interfaces to the HIP and ROCm libraries, hipFORT ships the `hipfc` wrapper compiler and a `Makefile. fort` that can be included in a project's build system. hipfc is in the `bin/` subdirectory, and Makefile.hipfort is in share/hipfort of the repository. While both can be configured using a number of environment variables, ` hipfc` also understands a greater number of command line options that you can print to the screen using `hipfc -h.`
136127

128+
.. note::
129+
130+
The hipfc wrapper compiler is deprecated and will be removed in a future release. Users are
131+
encouraged to call the Fortran or HIP compilers directly instead of relying on the hipfc wrapper.
132+
The hipfort component provides exported CMake targets that can be used to link to the appropriate
133+
ROCm libraries.
134+
137135
Among the environment variables, the most important are:
138136

139137
.. list-table::

docs/install/quick-start.rst

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,13 @@ Prerequisites
1515
Building and testing hipFORT from source
1616
==========================================
1717

18-
1. Ensure you have `gfortran`, `git`, `cmake`, and HIP installed.
18+
1. Ensure you have ``gfortran``, ``git``, ``cmake``, and HIP installed.
1919
2. Build, install, and test hipFORT from the source with the following commands:
2020

21-
.. code-block::
22-
23-
git clone https://github.com/ROCmSoftwarePlatform/hipfort
24-
mkdir build ; cd build
25-
cmake -DHIPFORT_INSTALL_DIR=/tmp/hipfort ..
26-
make install
27-
export PATH=/tmp/hipfort/bin:$PATH
28-
cd ../test/f2003/vecadd
29-
hipfc -v hip_implementation.cpp main.f03
30-
./a.out
31-
32-
33-
.. note::
34-
35-
The preceding steps demonstrate the `hipfc` utility. `hipfc` calls `hipcc` for non-Fortran files and then compiles the Fortran files and links to the object file created by `hipcc`.
21+
.. code-block::
3622
23+
git clone https://github.com/ROCm/hipfort.git
24+
cd hipfort
25+
cmake -S. -Bbuild -DHIPFORT_INSTALL_DIR=/tmp/hipfort -DBUILD_TESTING=ON
26+
make -C build
27+
make -C build check

0 commit comments

Comments
 (0)