-
Notifications
You must be signed in to change notification settings - Fork 307
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
Conversation
@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. |
doc/source/lilac/obtaining-building-and-running/obtaining-and-building-ctsm.rst
Outdated
Show resolved
Hide resolved
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.
@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".
doc/source/lilac/obtaining-building-and-running/obtaining-and-building-ctsm.rst
Outdated
Show resolved
Hide resolved
doc/source/lilac/obtaining-building-and-running/obtaining-and-building-ctsm.rst
Outdated
Show resolved
Hide resolved
@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? |
@ekluzek I already checked with @jedwards4b and he told me to use ./bin/git-fleximod in the documentation. |
@ekluzek by the time I read your suggestion, I had already updated the wiki using the interactive EDIT button. |
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 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.
doc/source/lilac/obtaining-building-and-running/obtaining-and-building-ctsm.rst
Outdated
Show resolved
Hide resolved
doc/source/lilac/obtaining-building-and-running/obtaining-and-building-ctsm.rst
Show resolved
Hide resolved
doc/source/lilac/obtaining-building-and-running/obtaining-and-building-ctsm.rst
Show resolved
Hide resolved
@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. |
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:
|
I merged this PR into #2559 and will now close this PR. |
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.