-
Notifications
You must be signed in to change notification settings - Fork 15.1k
[flang] flang manpage overhaul #144948
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[flang] flang manpage overhaul #144948
Conversation
|
This is how it is being rendered: |
c6ca314 to
e590330
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks this. I checked the rendering and it looks good.
Feel free to disregard some/all of the text edits below, though I think some of them are clearer than the corresponding text in clang.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for contributing this Pawel
flang/docs/CommandGuide/index.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This information about the different stages of compilation are interesting, but I imagine most users would already be familiar with compiler drivers with these features (e.g. classic flang can do all of this). I think maybe the description should start with a very short description of what the compiler supports: something like
Flang supports all of Fortran 95 and many newer language features. Flang supports OpenMP and has some support for OpenACC and CUDA.
I have been deliberately vague here because it could be easy to forget to update this documentation when new features are added. @clementval please could you advise on rough status of OpenACC and CUDA in upstream flang?
It might also be worth giving some very rough getting started information: e.g. observing that with some exceptions we support very similar flags to gfortran and classic-flang.
I expect these two points would give the information that most Fortran programmers need to get started without them having to read much further. Maybe an example of how to compile a very simple fortran program would be beneficial too
flang [-fopenmp] file1.f90 file2.f90 -O3 -o program
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added this introductory phrase. As for the rest, note that my goal here was to maintain the parity with clang's manpage, e.g., it does not offer any examples, assuming the reader can derive what they need from the Synopsis section and from the list of available Options. Also I doubt typical Fortran programmers read manpages, they usually read books.
e590330 to
ebaa5dd
Compare
Make the flang man page look more like the one clang is having.
ebaa5dd to
1283068
Compare
|
Corrected a line that was too long. |
|
This is how it looks like after the recent changes: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the work on this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
Make the flang man page look more like the one clang is having.
Make the flang man page look more like the one clang is having.
Make the flang man page look more like the one clang is having.