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

Replace checkout_externals with git-fleximod in documentation #2564

Closed

Conversation

slevis-lmwg
Copy link
Contributor

@slevis-lmwg slevis-lmwg commented May 29, 2024

Description of changes

Detailed list of TODOs in the issue #2536.

Specific notes

Contributors other than yourself, if any:
@jedwards4b @ekluzek

CTSM Issues Fixed (include github issue #):
Fixes #2536
Fixes #2467 (unrelated to title)

Are answers expected to change (and if so in what way)?
No

Does this create a need to change or add documentation? Did you do so?
Yes, see files changed.

@slevis-lmwg slevis-lmwg self-assigned this May 29, 2024
.gitignore Outdated Show resolved Hide resolved
@jedwards4b
Copy link
Contributor

@slevis-lmwg I think that you should have started from my branch - I've already made at least some of these changes.

@slevis-lmwg slevis-lmwg added the documentation additions or edits to user-facing documentation label May 29, 2024
@slevis-lmwg
Copy link
Contributor Author

@slevis-lmwg I think that you should have started from my branch - I've already made at least some of these changes.

Oh well, at least git will merge our branches easily.

.gitignore Outdated Show resolved Hide resolved
README_EXTERNALS.rst Outdated Show resolved Hide resolved
bld/CLMBuildNamelist.pm Show resolved Hide resolved
Copy link
Collaborator

@ekluzek ekluzek left a comment

Choose a reason for hiding this comment

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

@slevis-lmwg good start here. I have some suggestions for changes.

In terms of bringing this in, one way to do this would be to merge it with Jim's PR and then make this a PR to his. As part of merging you'll resolve the conflicts of the same things that are done there here as well.

Also the wiki to update is the CTSM wiki pages that have to do with manage_externals. Probably the best way to do that is to checkout the wiki (which you do with normal git commands, just a different fork I think it's CTSM.wiki?). Then you can do "git grep manage_externals".

README Outdated Show resolved Hide resolved
README Show resolved Hide resolved
bld/CLMBuildNamelist.pm Show resolved Hide resolved
@ekluzek
Copy link
Collaborator

ekluzek commented May 29, 2024

@slevis-lmwg the documentation here uses the git fleximod script under the bin directory for the instructions. Once a user has run "init" on that I think they can use "git fleximod" from within their version of git. This would be a more robust way of doing it so you don't have to worry about getting the path right. So I think you should update the documentation after the "init" step to use the command under git, rather than the script under bin. @jedwards4b I think I have that right correct?

@slevis-lmwg
Copy link
Contributor Author

@ekluzek I already checked with @jedwards4b and he told me to use ./bin/git-fleximod in the documentation.
See this post:
#2559 (comment)

@slevis-lmwg
Copy link
Contributor Author

Also the wiki to update is the CTSM wiki pages that have to do with manage_externals. Probably the best way to do that is to checkout the wiki (which you do with normal git commands, just a different fork I think it's CTSM.wiki?). Then you can do "git grep manage_externals".

@ekluzek by the time I read your suggestion, I had already updated the wiki using the interactive EDIT button.

Copy link
Contributor

@jedwards4b jedwards4b left a comment

Choose a reason for hiding this comment

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

I don't really feel that I need to rewrite this but someone does - maybe you should wait for one or two more beta tags so that you gain some experience and have a better idea of what to say.

README_GITFLEXIMOD.rst Outdated Show resolved Hide resolved
README_GITFLEXIMOD.rst Outdated Show resolved Hide resolved
README_GITFLEXIMOD.rst Outdated Show resolved Hide resolved
README_GITFLEXIMOD.rst Outdated Show resolved Hide resolved
README_GITFLEXIMOD.rst Outdated Show resolved Hide resolved
README_GITFLEXIMOD.rst Outdated Show resolved Hide resolved
README_GITFLEXIMOD.rst Outdated Show resolved Hide resolved
README_GITFLEXIMOD.rst Show resolved Hide resolved
@jedwards4b
Copy link
Contributor

@ekluzek @slevis-lmwg the PR #2559 is a roadblock for cam and cesm PR's. This one is not, please consider merging that one today and doing this in an alpha02 tag.

@slevis-lmwg
Copy link
Contributor Author

slevis-lmwg commented May 31, 2024

Everything here is resolved. I opened an issue for one thing that Jim and Erik suggested. I will let Bill open an issue for another couple of things that Jim suggested if Bill finds it necessary.

Last things to do here and in #2559:

  • Jim and/or Erik approve this PR
  • Jim and Erik figure out why git-fleximod does not work for Erik
  • Someone prepares the ChangeLog/ChangeSum entry; Jim have you started this? Would you rather I did it?
  • Jim and Erik, I assume that I will do the merge, right? Options:
  1. I merge Jim's branch with my branch and I merge this PR to main (or vice versa)
  2. I merge Jim's branch to main and then merge my branch to main and make one tag for both (or make two tags?)
  3. Other better options?

@slevis-lmwg
Copy link
Contributor Author

From direct communication with @ekluzek:
I will merge this PR with #2559, so as to merge #2559 to main.

@slevis-lmwg
Copy link
Contributor Author

I merged this PR into #2559 and will now close this PR.

@slevis-lmwg slevis-lmwg deleted the git-fleximod_documentation branch May 31, 2024 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation additions or edits to user-facing documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation for git-fleximod Remove references to cheyenne from the testlist
3 participants