From ac2480bca9ee295b544c5b47ea00e67dadcccafc Mon Sep 17 00:00:00 2001 From: terminalforlife Date: Thu, 12 Nov 2020 03:38:29 +0000 Subject: [PATCH] Bring consistency of formatting to ch-* sheets --- sheets/ch-build | 5 ++--- sheets/ch-build2dir | 5 ++--- sheets/ch-builder2squash | 5 ++--- sheets/ch-builder2tar | 5 ++--- sheets/ch-dir2squash | 5 ++--- sheets/ch-grow | 6 ++---- sheets/ch-mount | 5 ++--- sheets/ch-pull2dir | 5 ++--- sheets/ch-pull2tar | 5 ++--- sheets/ch-run | 5 ++--- sheets/ch-tar2dir | 7 +++---- 11 files changed, 23 insertions(+), 35 deletions(-) diff --git a/sheets/ch-build b/sheets/ch-build index 7537e2b..281c798 100644 --- a/sheets/ch-build +++ b/sheets/ch-build @@ -2,7 +2,6 @@ # Utility to build a Charliecloud image and place it in the builder’s back-end # storage. More information: . -# Create an image tagged foo and specified by the file /bar/Dockerfile. -# Use /bar as the Docker context directory. Use the default builder. +# Create an image tagged foo and specified by the file /bar/Dockerfile. Use +# /bar as the Docker context directory. Use the default builder. ch-build -t foo --file=/bar/Dockerfile /bar - diff --git a/sheets/ch-build2dir b/sheets/ch-build2dir index b5959b1..0c00f32 100644 --- a/sheets/ch-build2dir +++ b/sheets/ch-build2dir @@ -2,7 +2,6 @@ # Utility to build a Charliecloud image from Dockerfile and unpack it into a # directory. More information: . -# Build a Charliecloud image using ./Dockerfile.foo and create image -# directory /var/tmp/foo +# Build a Charliecloud image using './Dockerfile.foo' and create image +# directory '/var/tmp/foo'. ch-build2dir -t foo -f ./Dockerfile.foo . /var/tmp - diff --git a/sheets/ch-builder2squash b/sheets/ch-builder2squash index 21da863..973864a 100644 --- a/sheets/ch-builder2squash +++ b/sheets/ch-builder2squash @@ -2,7 +2,6 @@ # Utility to flatten a builder image into a Charliecloud SquashFS file. # More information: . -# Flattens the builder image tagged "debian" into a SquashFS file named -# debian.sqfs in /var/tmp. +# Flattens the builder image tagged 'debian' into a SquashFS file named +# 'debian.sqfs' in '/var/tmp'. ch-builder2squash debian /var/tmp - diff --git a/sheets/ch-builder2tar b/sheets/ch-builder2tar index 69d9cee..d0e7eee 100644 --- a/sheets/ch-builder2tar +++ b/sheets/ch-builder2tar @@ -2,7 +2,6 @@ # Utility to flatten a builder image into a Charliecloud image tarball. # More information: . -# Flatten the builder image tagged "hello" into a Charliecloud tarball in -# directory /var/tmp +# Flatten the builder image tagged 'hello' into a Charliecloud tarball in +# directory '/var/tmp'. ch-builder2tar hello /var/tmp - diff --git a/sheets/ch-dir2squash b/sheets/ch-dir2squash index 1f55100..0c033c1 100644 --- a/sheets/ch-dir2squash +++ b/sheets/ch-dir2squash @@ -2,7 +2,6 @@ # Utility to create a SquashFS file from a Charliecloud image directory. # More information: . -# Create a Charliecloud SquashFS file debian.sqfs under the directory /var/tmp -# from the image directory /var/tmp/debian. +# Create a Charliecloud SquashFS file debian.sqfs under the directory +# '/var/tmp' from the image directory '/var/tmp/debian'. ch-dir2squash /var/tmp/debian /var/tmp - diff --git a/sheets/ch-grow b/sheets/ch-grow index 160e610..3f5011e 100644 --- a/sheets/ch-grow +++ b/sheets/ch-grow @@ -3,10 +3,8 @@ # It is completely unprivileged, with no setuid/setgid/setcap helpers. # More information: . -# Build the image "bar" using ./foo/bar/Dockerfile and context directory -# ./foo/bar +# Build image 'bar' using './foo/bar/Dockerfile' and context dir './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 - diff --git a/sheets/ch-mount b/sheets/ch-mount index 9fce14e..f9672e2 100644 --- a/sheets/ch-mount +++ b/sheets/ch-mount @@ -2,7 +2,6 @@ # Utility to mount a SquashFS image file using FUSE. # More information: . -# Create a new empty directory named debian, then mount it on /var/tmp -# directory. The /var/tmp directory must not already exist. +# Create a new empty directory named 'debian', then mount it to '/var/tmp'. The +# '/var/tmp' directory must not already exist. ch-mount /var/tmp/debian.sqfs /var/tmp - diff --git a/sheets/ch-pull2dir b/sheets/ch-pull2dir index 6b78f80..b0b3b31 100644 --- a/sheets/ch-pull2dir +++ b/sheets/ch-pull2dir @@ -2,7 +2,6 @@ # Utility to pull an image from the Docker Hub and unpack it into a directory. # More information: . -# Pull Docker image named alpine:latest from Docker Hub and extract it into -# a subdirectory of /var/tmp. A temporary tarball will be stored in /var/tmp. +# Pull Docker image named 'alpine:latest' from Docker Hub, then extract it into +# a subdirectory named '/var/tmp', in which a temporary tarball will be stored. ch-pull2dir alpine:latest /var/tmp - diff --git a/sheets/ch-pull2tar b/sheets/ch-pull2tar index e9d8731..a363c4f 100644 --- a/sheets/ch-pull2tar +++ b/sheets/ch-pull2tar @@ -2,7 +2,6 @@ # Utility to pull an image from the Docker Hub and flatten it into a tarball. # More information: . -# Pull a Docker image named alpine:latest from Docker Hub and flatten it into -# a Charliecloud tarball in the directory /var/tmp. +# Pull a Docker image named 'alpine:latest' from Docker Hub and flatten it into +# a Charliecloud tarball in the directory '/var/tmp'. ch-pull2tar alpine:latest /var/tmp - diff --git a/sheets/ch-run b/sheets/ch-run index f4e5f11..a473618 100644 --- a/sheets/ch-run +++ b/sheets/ch-run @@ -2,7 +2,6 @@ # Utility to run a command in a Charliecloud container. # More information: . -# Run the command echo hello inside a Charliecloud container using -# the unpacked image at /data/foo. +# Run the given `echo` command inside a Charliecloud container, using the +# unpacked image at '/data/foo'. ch-run /data/foo -- echo hello - diff --git a/sheets/ch-tar2dir b/sheets/ch-tar2dir index 8d93801..8e49070 100644 --- a/sheets/ch-tar2dir +++ b/sheets/ch-tar2dir @@ -2,8 +2,7 @@ # Utility to unpack a Charliecloud image tarball into a directory. # More information: . -# Extract the 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 -# by ch-builder2tar. +# Extract tarball '/var/tmp/hello.tar.gz' into a subdirectory of '/var/tmp'. +# The tarball must contain a Linux filesystem image, such as is created by +# ch-builder2tar. ch-tar2dir /var/tmp/hello.tar.gz /var/tmp -