Bring consistency of formatting to ch-* sheets

pull/130/head
terminalforlife 4 years ago
parent bb5e860c01
commit ac2480bca9

@ -2,7 +2,6 @@
# Utility to build a Charliecloud image and place it in the builders back-end # Utility to build a Charliecloud image and place it in the builders back-end
# storage. More information: <https://github.com/hpc/charliecloud>. # storage. More information: <https://github.com/hpc/charliecloud>.
# Create an image tagged foo and specified by the file /bar/Dockerfile. # Create an image tagged foo and specified by the file /bar/Dockerfile. Use
# Use /bar as the Docker context directory. Use the default builder. # /bar as the Docker context directory. Use the default builder.
ch-build -t foo --file=/bar/Dockerfile /bar ch-build -t foo --file=/bar/Dockerfile /bar

@ -2,7 +2,6 @@
# Utility to build a Charliecloud image from Dockerfile and unpack it into a # Utility to build a Charliecloud image from Dockerfile and unpack it into a
# directory. More information: <https://github.com/hpc/charliecloud>. # directory. More information: <https://github.com/hpc/charliecloud>.
# Build a Charliecloud image using ./Dockerfile.foo and create image # Build a Charliecloud image using './Dockerfile.foo' and create image
# directory /var/tmp/foo # directory '/var/tmp/foo'.
ch-build2dir -t foo -f ./Dockerfile.foo . /var/tmp ch-build2dir -t foo -f ./Dockerfile.foo . /var/tmp

@ -2,7 +2,6 @@
# Utility to flatten a builder image into a Charliecloud SquashFS file. # Utility to flatten a builder image into a Charliecloud SquashFS file.
# More information: <https://github.com/hpc/charliecloud>. # More information: <https://github.com/hpc/charliecloud>.
# Flattens the builder image tagged "debian" into a SquashFS file named # Flattens the builder image tagged 'debian' into a SquashFS file named
# debian.sqfs in /var/tmp. # 'debian.sqfs' in '/var/tmp'.
ch-builder2squash debian /var/tmp ch-builder2squash debian /var/tmp

@ -2,7 +2,6 @@
# Utility to flatten a builder image into a Charliecloud image tarball. # Utility to flatten a builder image into a Charliecloud image tarball.
# More information: <https://github.com/hpc/charliecloud>. # More information: <https://github.com/hpc/charliecloud>.
# Flatten the builder image tagged "hello" into a Charliecloud tarball in # Flatten the builder image tagged 'hello' into a Charliecloud tarball in
# directory /var/tmp # directory '/var/tmp'.
ch-builder2tar hello /var/tmp ch-builder2tar hello /var/tmp

@ -2,7 +2,6 @@
# Utility to create a SquashFS file from a Charliecloud image directory. # Utility to create a SquashFS file from a Charliecloud image directory.
# More information: <https://github.com/hpc/charliecloud>. # More information: <https://github.com/hpc/charliecloud>.
# Create a Charliecloud SquashFS file debian.sqfs under the directory /var/tmp # Create a Charliecloud SquashFS file debian.sqfs under the directory
# from the image directory /var/tmp/debian. # '/var/tmp' from the image directory '/var/tmp/debian'.
ch-dir2squash /var/tmp/debian /var/tmp ch-dir2squash /var/tmp/debian /var/tmp

@ -3,10 +3,8 @@
# It is completely unprivileged, with no setuid/setgid/setcap helpers. # It is completely unprivileged, with no setuid/setgid/setcap helpers.
# More information: <https://github.com/hpc/charliecloud>. # More information: <https://github.com/hpc/charliecloud>.
# Build the image "bar" using ./foo/bar/Dockerfile and context directory # Build image 'bar' using './foo/bar/Dockerfile' and context dir './foo/bar'.
# ./foo/bar
ch-grow build -t bar -f ./foo/bar/Dockerfile ./foo/bar ch-grow build -t bar -f ./foo/bar/Dockerfile ./foo/bar
# Download the Debian Buster image and place it in /tmp/buster. # Download the Debian Buster image and place it in '/tmp/buster'.
ch-grow pull debian:buster /tmp/buster ch-grow pull debian:buster /tmp/buster

@ -2,7 +2,6 @@
# Utility to mount a SquashFS image file using FUSE. # Utility to mount a SquashFS image file using FUSE.
# More information: <https://github.com/hpc/charliecloud>. # More information: <https://github.com/hpc/charliecloud>.
# Create a new empty directory named debian, then mount it on /var/tmp # Create a new empty directory named 'debian', then mount it to '/var/tmp'. The
# directory. The /var/tmp directory must not already exist. # '/var/tmp' directory must not already exist.
ch-mount /var/tmp/debian.sqfs /var/tmp ch-mount /var/tmp/debian.sqfs /var/tmp

@ -2,7 +2,6 @@
# Utility to pull an image from the Docker Hub and unpack it into a directory. # Utility to pull an image from the Docker Hub and unpack it into a directory.
# More information: <https://github.com/hpc/charliecloud>. # More information: <https://github.com/hpc/charliecloud>.
# Pull Docker image named alpine:latest from Docker Hub and extract it into # Pull Docker image named 'alpine:latest' from Docker Hub, then extract it into
# a subdirectory of /var/tmp. A temporary tarball will be stored in /var/tmp. # a subdirectory named '/var/tmp', in which a temporary tarball will be stored.
ch-pull2dir alpine:latest /var/tmp ch-pull2dir alpine:latest /var/tmp

@ -2,7 +2,6 @@
# Utility to pull an image from the Docker Hub and flatten it into a tarball. # Utility to pull an image from the Docker Hub and flatten it into a tarball.
# More information: <https://github.com/hpc/charliecloud>. # More information: <https://github.com/hpc/charliecloud>.
# Pull a Docker image named alpine:latest from Docker Hub and flatten it into # Pull a Docker image named 'alpine:latest' from Docker Hub and flatten it into
# a Charliecloud tarball in the directory /var/tmp. # a Charliecloud tarball in the directory '/var/tmp'.
ch-pull2tar alpine:latest /var/tmp ch-pull2tar alpine:latest /var/tmp

@ -2,7 +2,6 @@
# Utility to run a command in a Charliecloud container. # Utility to run a command in a Charliecloud container.
# More information: <https://github.com/hpc/charliecloud>. # More information: <https://github.com/hpc/charliecloud>.
# Run the command echo hello inside a Charliecloud container using # Run the given `echo` command inside a Charliecloud container, using the
# the unpacked image at /data/foo. # unpacked image at '/data/foo'.
ch-run /data/foo -- echo hello ch-run /data/foo -- echo hello

@ -2,8 +2,7 @@
# Utility to unpack a Charliecloud image tarball into a directory. # Utility to unpack a Charliecloud image tarball into a directory.
# More information: <https://github.com/hpc/charliecloud>. # More information: <https://github.com/hpc/charliecloud>.
# Extract the tarball /var/tmp/hello.tar.gz into a subdirectory of /var/tmp. # Extract tarball '/var/tmp/hello.tar.gz' into a subdirectory of '/var/tmp'.
# hello.tar.gz must contain a Linux filesystem image, e.g. as created # The tarball must contain a Linux filesystem image, such as is created by
# by ch-builder2tar. # ch-builder2tar.
ch-tar2dir /var/tmp/hello.tar.gz /var/tmp ch-tar2dir /var/tmp/hello.tar.gz /var/tmp

Loading…
Cancel
Save