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.

Sign up for GitHub

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

Jump to bottom

doc: add usage note for --add-file submission cli option #5239

Merged
merged 1 commit into from Jun 8, 2023
Merged

doc: add usage note for --add-file submission cli option #5239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/man1/common/submit-other-options.rst
View file
Open in desktop
Expand Up @@ -48,6 +48,12 @@ OTHER OPTIONS
encode multiple files. Note: As documented in RFC 14, the file names
``script`` and ``conf.json`` are both reserved.

.. note::
This option should only be used for small files such as program input
parameters, configuration, scripts, and so on. For broadcast of large
files, binaries, and directories, the :man1:`flux-shell` ``stage-in``
plugin will be more appropriate.

**--conf=FILE|KEY=VAL|STRING|NAME**
The ``--conf`` option allows configuration for a Flux instance started
via ``flux-batch(1)`` or ``flux-alloc(1)`` to be iteratively built on
Expand Down