Skip to content

Conversation

@carns
Copy link

@carns carns commented Jun 9, 2025

The Darshan documentation still advocates for generating custom MPI compiler wrapper scripts with Darshan instrumentation. This method was developed for MPICH 2 and early versions of MPICH 3 and isn't really appropriate for any recent versions of MPICH. The profile method is far less fragile.

  • remove the generators themselves
  • refactor the runtime documentation a bit (remove discussion of wrapper generator scripts, reorganize remaining options into subsections in priority of Cray option, MPICH option, then manual option)

Note that this PR conflicts with #1033 probably. If that one lands first, I can revise this to update the rtd version of the documentation instead.

@wkliao
Copy link
Collaborator

wkliao commented Jun 9, 2025

I can see the only conflict is the changes to file darshan-runtime.txt.
Once #1033 is merged, I can push a commit to this PR to resolve the conflict.

@wkliao wkliao force-pushed the carns/deprecate-wrapper-method branch from 505f4f1 to 75d04a6 Compare June 10, 2025 17:36
@carns carns force-pushed the carns/deprecate-wrapper-method branch from 75d04a6 to b8b51ad Compare September 15, 2025 20:39
@carns carns requested a review from wkliao September 15, 2025 21:02
@carns
Copy link
Author

carns commented Sep 15, 2025

I think this is up to date now. I'll open a separate PR to remove the old .txt documentation files; they aren't needed now that we have fully migrated to RTD.

Copy link
Collaborator

@wkliao wkliao left a comment

Choose a reason for hiding this comment

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

File darshan-runtime/Makefile.am contains the followings lines that need to be removed.
They cause Github CI actions to fail.

              darshan-gen-cc.pl \
              darshan-gen-cxx.pl \
              darshan-gen-fortran.pl \

Phil Carns added 3 commits September 16, 2025 11:20
- remove the generators themselves
- refactor the runtime documentation a bit (remove discussion of wrapper
  generator scripts, reorganize remaining options into subsections in
  priority of Cray option, MPICH option, then manual option)
@carns carns force-pushed the carns/deprecate-wrapper-method branch from d472421 to 54aa481 Compare September 16, 2025 15:21
@carns
Copy link
Author

carns commented Sep 16, 2025

File darshan-runtime/Makefile.am contains the followings lines that need to be removed. They cause Github CI actions to fail.

              darshan-gen-cc.pl \
              darshan-gen-cxx.pl \
              darshan-gen-fortran.pl \

Thanks! Fixed now. I also rebased to account for the removal of the .txt documents in the other PR.

@wkliao wkliao merged commit b30ce48 into main Sep 16, 2025
7 checks passed
@wkliao wkliao deleted the carns/deprecate-wrapper-method branch October 17, 2025 18:25
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.

3 participants