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

remove newline replace to fix formatting of help options #90

Merged
merged 1 commit into from
Oct 9, 2023
Merged

Conversation

lastephey
Copy link
Collaborator

Addresses #77

It looks like we had an unnecessary newline replace with a double escape. I took it out and tested and it looks ok.

Without fix:

stephey@alvarez:login01:~> podman-hpc run --help
Run a command in a new container

Description:
  Runs a command in a new container from the given image

Usage:
  podman-hpc run [options] IMAGE [COMMAND [ARG...]]

Examples:
  podman-hpc run imageID ls -alF /etc
  podman-hpc run --network=host imageID dnf -y install java
  podman-hpc run --volume /var/hostdir:/var/ctrdir -i -t fedora /bin/bash

Podman-hpc Options:\n  --cuda-mpi  Enable CUDA-aware Cray MPICH Support\n  --cvmfs     Enable cmvfs filesystem\n  --gpu       Enable NVIDIA GPU Support\n  --mpi       Enable Cray MPICH Support\n  --nccl      Enable SS11 support for NCCL\n\nPodman options follow:
      --add-host strings                         Add a custom host-to-IP mapping (host:ip) (default [])
      --annotation strings                       Add annotations to container (key=value)
      --arch ARCH                                use ARCH instead of the architecture of the machine for choosing images
  -a, --attach strings                           Attach to STDIN, STDOUT or STDERR

With fix:

stephey@nid200000:~> podman-hpc run --help
Run a command in a new container

Description:
  Runs a command in a new container from the given image

Usage:
  podman-hpc run [options] IMAGE [COMMAND [ARG...]]

Examples:
  podman-hpc run imageID ls -alF /etc
  podman-hpc run --network=host imageID dnf -y install java
  podman-hpc run --volume /var/hostdir:/var/ctrdir -i -t fedora /bin/bash

Podman-hpc Options:
  --cuda-mpi  Enable CUDA-aware Cray MPICH Support
  --cvmfs     Enable cmvfs filesystem
  --gpu       Enable NVIDIA GPU Support
  --mpi       Enable Cray MPICH Support
  --nccl      Enable SS11 support for NCCL

Podman options follow:
      --add-host strings                         Add a custom host-to-IP mapping (host:ip) (default [])
      --annotation strings                       Add annotations to container (key=value)
      --arch ARCH                                use ARCH instead of the architecture of the machine for choosing images
  -a, --attach strings                           Attach to STDIN, STDOUT or STDERR

@lastephey lastephey requested review from scanon and danfulton October 7, 2023 00:30
@danfulton
Copy link
Member

This looks fine to me if it works. I'm not sure why I would have written it the other way in the first place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants