Skip to content

Commit 1bc0e4e

Browse files
authored
Merge pull request #6 from NordicHPC/rkdarst/arguments-with-equals
README: docker/singularity: recommend options using =
2 parents f114617 + 5d7d536 commit 1bc0e4e

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,10 @@ Any unknown argument is passed directly to the `docker run` call, and
194194
thus can be any normal Docker argument. If `,copy` is included in the
195195
`--mount` command options, the directory will be copied before
196196
mounting. This may be useful if the directory is on a network mount
197-
which the root docker can't access.
197+
which the root docker can't access. It is recommended to always use
198+
the form of options with `=`, such as `--option=X`, rather than
199+
separating them with a space, to avoid problems with argument/option
200+
detection.
198201

199202

200203

@@ -230,8 +233,11 @@ envkernel singularity --name=NAME [envkernel options] [singularity options] [ima
230233
default if you don't `--contain`.
231234

232235
Any unknown argument is passed directly to the `singularity exec`
233-
call, and thus can be any normal Singularity arguments. The most
234-
useful Singularity options are (nothing envkernel specific here):
236+
call, and thus can be any normal Singularity arguments. It is
237+
recommended to always use the form of options with `=`, such as
238+
`--bind=X`, rather than separating them with a space, to avoid
239+
problems with argument/option detection. The most useful Singularity
240+
options are (nothing envkernel specific here):
235241

236242
* `--contain` or `-c`: Don't share any filesystems by default.
237243

0 commit comments

Comments
 (0)