[PATCH] D104229: [flang][docs] Add documentation for the new Flang driver
Arnamoy B via Phabricator via llvm-commits
llvm-commits at lists.llvm.org
Fri Jun 18 05:50:23 PDT 2021
arnamoy10 added inline comments.
================
Comment at: flang/docs/FlangDriver.md:26
+The frontend driver glues all of the frontend libraries together and provides
+an easy to use and intuitive interface to the frontend. It accepts many
+frontend-specific options not available in `flang` and as such it provides a
----------------
[Nit] easy to use --> easy-to-use
================
Comment at: flang/docs/FlangDriver.md:56
+
+In most cases, the driver crates a chain of actions/jobs/phases where the
+output from one action is the input for the subsequent one. You can use the
----------------
[Nit] crates -> creates
================
Comment at: flang/docs/FlangDriver.md:153
+`FlangOption` among its `Flags`) that you also intend to be understood by for
+the frontend, make sure that it is either forwarded to `flang -fc1` or
+translated into some other option that is accepted by the frontend driver. You
----------------
[Nit] Understood by for the frontend -> Understood by the frontend
================
Comment at: flang/docs/FlangDriver.md:156
+can implement this in `clang/lib/Driver/ToolChains/Flang.cpp`. Plain command
+line option forwarding for Flang is tested in
+`flang/test/Driver/frontend-forward.F90`.
----------------
May want to elaborate what you mean by "Plain command line option", or reword
================
Comment at: flang/docs/FlangDriver.md:179
+For most regression tests for the frontend, you will want to use `%flang_fc1`.
+In some cases the observable behaviour will be identical regardless of whether
+`%flang` or `%flang_fc1` is used. However, when you are using `%flang` instead
----------------
[Nit] In some cases --> In some cases,
================
Comment at: flang/docs/FlangDriver.md:184
+be exactly what you want to test. In fact, you can check these additional
+flags by using the `-###` compiler driver command line option.
----------------
Not sure if we want to document the use of `!REQUIRES` here
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D104229/new/
https://reviews.llvm.org/D104229
More information about the llvm-commits
mailing list