Skip to content
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

Add note about GFortran usability to docs #302

Merged
merged 1 commit into from Apr 17, 2019
Merged

Conversation

CamStan
Copy link
Member

@CamStan CamStan commented Apr 16, 2019

This adds a note about compatibility with GFortran to the docs and lets users know about issue #300.

This was accomplished with #288

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance enhancement (non-breaking change which improves efficiency)
  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (a change to man pages or other documentation)

@@ -4,6 +4,12 @@ Mounting UnifyCR

In this section, we describe how to use the UnifyCR API in an application.

.. Note:: **Fortran Compatibility**

``unifycr_mount`` and ``unifycr_unmount`` are now usable with GFortran.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @CamStan . Just because this looks strange to me, let's use the name in all lower case as "gfortran". That's how I see it most of the time.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, seems to use lots of variants out on the web: "GFortran", "Gfortran", "gfortran", so I take that back. Good how you have it.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, we should mention that a Fortran application needs to link with:

-lunifycrf -lunifycr_gotcha

@adammoody
Copy link
Collaborator

And let's mention that the Fortran source needs to include unifycrf.h:

include 'unifycrf.h'

As an example for how to integrate the UNIFYCR_MOUNT/UNMOUNT calls, we could point users to: https://github.com/LLNL/UnifyCR/blob/dev/examples/src/writeread.f90

@CamStan
Copy link
Member Author

CamStan commented Apr 17, 2019

Updated.

.. code-block:: Bash

$ mpif90 -o test_write test_write.F \
-I<unifycr>/include -L<unifycy>/lib -lunifycrf -lunifycr_gotcha \
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adammoody, I want to double check that this is correct.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside from the extra \ on the end...

@adammoody
Copy link
Collaborator

Nice! Thanks, @CamStan

@CamStan CamStan deleted the docs-fortran branch April 17, 2019 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants