Skip to content

Commit e094868

Browse files
tarunprabhuLukacma
authored andcommitted
[flang][docs] Replace references to f18 with flang (Part 2)
IntrinsicTypes.md has not been edited because, at the time that this PR was posted, there was another open PR updating that file. The replacement of f18 with flang will either be performed as part of that PR, or in a later commit.
1 parent 29b6edc commit e094868

File tree

9 files changed

+19
-19
lines changed

9 files changed

+19
-19
lines changed

flang/docs/IORuntimeInternals.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ local:
1515
```
1616

1717
This note is meant to be an overview of the design of the *implementation*
18-
of the f18 Fortran compiler's runtime support library for I/O statements.
18+
of Flang's runtime support library for I/O statements.
1919

2020
The *interface* to the I/O runtime support library is defined in the
2121
C++ header file `runtime/io-api.h`.
@@ -66,7 +66,7 @@ modified with optional template arguments that override their
6666
allocators and deallocators.
6767

6868
Conversions between the many binary floating-point formats supported
69-
by f18 and their decimal representations are performed with the same
69+
by Flang and their decimal representations are performed with the same
7070
template library of fast conversion algorithms used to interpret
7171
floating-point values in Fortran source programs and to emit them
7272
to module files.
@@ -245,7 +245,7 @@ for this purpose.
245245

246246
### `IoStatementState`
247247

248-
F18's Fortran I/O runtime support library defines and implements an API
248+
Flang's Fortran I/O runtime support library defines and implements an API
249249
that uses a sequence of function calls to implement each Fortran I/O
250250
statement.
251251
The state of each I/O statement in progress is maintained in some

flang/docs/ModFiles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ but this one doesn't.
3636
The disadvantage of using the same name as other compilers is that it is not
3737
clear which compiler created a `.mod` file and files from multiple compilers
3838
cannot be in the same directory. This can be solved by adding something
39-
between the module name and extension, e.g. `<modulename>-f18.mod`. When
39+
between the module name and extension, e.g. `<modulename>-flang.mod`. When
4040
this is needed, Flang accepts the option `-module-suffix` to alter the suffix.
4141

4242
## Format

flang/docs/OpenACC-descriptor-management.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ contains
300300

301301
### Other variables
302302

303-
F18 compiler also uses descriptors for assumed-shape, assumed-rank, polymorphic, ... variables. The OpenACC specification does not prescribe how an implementation should manage the descriptors for such variables. In many (all?) cases the descriptors of these variables have a local scope of a single subprogram, and if a descriptor of such a variable is created on the device, then its live range must be limited on the device by the invocation of the subprogram (with any OpenACC constructs inside it).
303+
Flang also uses descriptors for assumed-shape, assumed-rank, polymorphic, ... variables. The OpenACC specification does not prescribe how an implementation should manage the descriptors for such variables. In many (all?) cases the descriptors of these variables have a local scope of a single subprogram, and if a descriptor of such a variable is created on the device, then its live range must be limited on the device by the invocation of the subprogram (with any OpenACC constructs inside it).
304304

305305
For example:
306306

@@ -330,15 +330,15 @@ Pointer attachment for POINTER and ALLOCATABLE variables is a "composite" runtim
330330

331331
## Representing pointer attachment in MLIR OpenACC dialect
332332

333-
The Fortran pointer attachment logic specified by OpenACC is not trivial, and in order to be expressed in a language independent MLIR OpenACC dialect we propose to use recipes for delegating the complexity of the implementation to F18 runtime.
333+
The Fortran pointer attachment logic specified by OpenACC is not trivial, and in order to be expressed in a language independent MLIR OpenACC dialect we propose to use recipes for delegating the complexity of the implementation to Flang's runtime.
334334

335335
```Fortran
336336
!$acc enter data attach(d%p)
337337
```
338338

339-
The frontend generates an `acc.attach` data operation with `augPtr` being an address of the F18 descriptor representing a POINTER/ALLOCATABLE variable. Note that `augPtr` refers to an abstract augmented pointer structure, which is handled in a language specific manner by the code provided by the `attachRecipe` reference.
339+
The frontend generates an `acc.attach` data operation with `augPtr` being an address of the Flang descriptor representing a POINTER/ALLOCATABLE variable. Note that `augPtr` refers to an abstract augmented pointer structure, which is handled in a language specific manner by the code provided by the `attachRecipe` reference.
340340

341-
The `attachRecipe` is a callback that takes `varPtr` and `augPtr` pointers, and the section's `offset` and `size` computed from the `bounds` operand of `acc.attach`. Fortran FE passes these arguments directly to F18 runtime that is aware of the descriptor structure and does all the required checks and device memory updates for the device copy of the descriptor, including the attachment counters updates.
341+
The `attachRecipe` is a callback that takes `varPtr` and `augPtr` pointers, and the section's `offset` and `size` computed from the `bounds` operand of `acc.attach`. Fortran FE passes these arguments directly to Flang's runtime that is aware of the descriptor structure and does all the required checks and device memory updates for the device copy of the descriptor, including the attachment counters updates.
342342

343343
```
344344
acc.attach.recipe @attach_ref :
@@ -387,7 +387,7 @@ For other data clauses there is an implied ordering that the data action happens
387387

388388
Here, the `copyin` of the data is followed by the pointer attachment.
389389

390-
### F18 runtime support
390+
### Flang runtime support
391391

392392
The `OpenACCAttachDescriptor` API is defined like this:
393393

@@ -427,7 +427,7 @@ The implementation's behavior may be described as (OpenACC 2.7.2):
427427
428428
All the "is-present" checks and the data actions for the auxiliary pointers must be performed atomically with regards to the present counters bookkeeping.
429429
430-
The API relies on the primitives provided by `liboffload`, so it is provided by a new F18 runtime library, e.g. `FortranOffloadRuntime`, that depends on `flang_rt.runtime` and `liboffload`. The F18 driver adds `FortranOffloadRuntime` for linking under `-fopenacc`/`-fopenmp` (and maybe additional switches like `-fopenmp-targets`).
430+
The API relies on the primitives provided by `liboffload`, so it is provided by a new Flang runtime library, e.g. `FortranOffloadRuntime`, that depends on `flang_rt.runtime` and `liboffload`. Flang's driver adds `FortranOffloadRuntime` for linking under `-fopenacc`/`-fopenmp` (and maybe additional switches like `-fopenmp-targets`).
431431
432432
## TODOs:
433433

flang/docs/OpenMP-semantics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ local:
1414
---
1515
```
1616

17-
## OpenMP for F18
17+
## OpenMP for Flang
1818

1919
1. Define and document the parse tree representation for
2020
* Directives (listed below)
@@ -68,7 +68,7 @@ starting from `!$OMP`.
6868
In `parser-tree.h`,
6969
`OpenMPDeclarativeConstruct` is part
7070
of the `SpecificationConstruct` and `SpecificationPart`
71-
in F18 because
71+
in Flang because
7272
a declarative directive can only be placed in the specification part
7373
of a Fortran program.
7474

flang/docs/OptionComparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
# Compiler options comparison
1010

11-
This document catalogs the options processed by F18's peers/competitors. Much of the document is taken up by a set of tables that list the options categorized into different topics. Some of the table headings link to more information about the contents of the tables. For example, the table on **Standards conformance** options links to <a href=#standards">notes on Standards conformance</a>.
11+
This document catalogs the options processed by Flang's peers/competitors. Much of the document is taken up by a set of tables that list the options categorized into different topics. Some of the table headings link to more information about the contents of the tables. For example, the table on **Standards conformance** options links to <a href=#standards">notes on Standards conformance</a>.
1212

1313
**There's also important information in the ___[Appendix section](#appendix)___ near the end of the document on how this data was gathered and what ___is___ and ___is not___ included in this document.**
1414

flang/docs/Parsing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
-->
88

9-
# The F18 Parser
9+
# The Flang Parser
1010

1111
```{contents}
1212
---

flang/docs/Preprocessing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The first block of tests (`pp0*.F`) are all fixed-form source files;
163163
the second block (`pp1*.F90`) are free-form source files.
164164

165165
```
166-
f18
166+
flang
167167
| pgfortran
168168
| | ifort
169169
| | | gfortran

flang/docs/RuntimeDescriptor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ pointer.
399399
This design in the Standard precludes the use of static descriptors that
400400
could be associated with dynamic base addresses.
401401

402-
The F18 runtime cannot use just the mandated interoperable
402+
Flang's runtime cannot use just the mandated interoperable
403403
`struct CFI_cdesc_t` argument descriptor structure as its
404404
all-purpose data descriptor.
405405
It has no information about derived type components, overridable

flang/docs/RuntimeTypeInfo.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The runtime library uses *derived type description* tables to represent
2727
the relevant characteristics of derived types.
2828
This note summarizes the requirements for these descriptions.
2929

30-
The semantics phase of the F18 frontend constructs derived type
30+
The semantics phase of Flang's frontend constructs derived type
3131
descriptions from its scoped symbol table after name resolution
3232
and semantic constraint checking have succeeded.
3333
The lowering phase then transfers the tables to the static
@@ -85,7 +85,7 @@ bindings, and they do so in alphabetical order of binding name.
8585
(This is an arbitrary choice -- we could also define them to
8686
appear in binding declaration order, I suppose -- but a consistent
8787
ordering should be used so that relocatables generated by distinct
88-
versions of the F18 compiler will have a better chance to interoperate.)
88+
versions of Flang will have a better chance to interoperate.)
8989

9090
### Type parameter values and "same type" testing
9191

@@ -143,7 +143,7 @@ This means that it may or may not be passed by means of a descriptor.
143143
Note that a `FINAL` subroutine with a scalar argument does not define
144144
a finalizer for array objects unless the subroutine is elemental
145145
(and probably `IMPURE`).
146-
This seems to be a language pitfall and F18 will emit a
146+
This seems to be a language pitfall and Flang will emit a
147147
warning when an array of a finalizable derived type is declared
148148
with a rank lacking a `FINAL` subroutine when other ranks do have one.
149149

0 commit comments

Comments
 (0)