Skip to content

Commit 8695511

Browse files
committed
Add link and info on maintainer-clean
Signed-off-by: Jake Tronge <jtronge@lanl.gov>
1 parent 4689b61 commit 8695511

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/developers/bindings.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,15 +100,23 @@ generated by the script:
100100
The Fortran file ``api_f08_generated.F90`` contains all the internal subroutine
101101
definitions, each of which makes a call into corresponding C functions. Two
102102
different C files are generated: ``api_f08_ts_generated.c`` contains support
103-
for compilers with TS 29113 support, allowing the use of ``CFI_cdesc_t`` types;
104-
and ``api_f08_generated.c`` for compilers without TS 29113 support. The
105-
internal subroutine names are mapped to the external interface, including
106-
multiple interfaces for the bigcount version of functions, in
107-
``mpi-f08-interfaces-generated.h``.
103+
for compilers with TS 29113 support, allowing the use of ``CFI_cdesc_t`` types
104+
(see `Fortran 2018`_ for more details); and ``api_f08_generated.c`` for
105+
compilers without TS 29113 support. The internal subroutine names are mapped to
106+
the external interface, including multiple interfaces for the bigcount version
107+
of functions, in ``mpi-f08-interfaces-generated.h``.
108+
109+
.. _Fortran 2018: https://fortranwiki.org/fortran/show/Fortran+2018
108110

109111
If a new type needs to be added, then one will need to extend
110112
``fortran_type.py`` in ``ompi/mpi/bindings/ompi_bindings`` with an additional
111113
type class specifying how to handle the type in the above generated files,
112114
including any required key-value attributes for more complicated types. New
113115
types use a ``Type`` base class with functions that can be implemented by
114116
derived classes, each returning expanded Fortran or C code.
117+
118+
Other Considerations
119+
--------------------
120+
121+
Keep in mind that the generated files will not be deleted with a ``make clean``
122+
or ``make distclean``; instead use ``make maintainer-clean`` to delete those.

0 commit comments

Comments
 (0)