doc: add usage note for --add-file submission cli option #5239
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem: It may be tempting for users to use the --add-file=PATH job submission cli option to broadcast large files to their job, a use which would be inappropriate. Add a note to this option explaining when --add-file should be used vs the shell stage-in plugin.
Codecov Report
@@ Coverage Diff @@
## master #5239 +/- ##
==========================================
- Coverage 83.76% 83.75% -0.02%
==========================================
Files 448 448
Lines 75956 75956
==========================================
- Hits 63628 63619 -9
- Misses 12328 12337 +9 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem: It may be tempting for users to use the --add-file=PATH job submission cli option to broadcast large files to their job, a use which would be inappropriate.
Add a note to this option explaining when --add-file should be used vs the shell stage-in plugin.