From 72bf3d5d30885e3fac81d2a08ea860c5ba799b82 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Sat, 22 Jan 2022 04:31:53 -0500 Subject: [PATCH] docs: clarify unit for container memory limit --- README.md | 4 ++-- subcommands/clone | 2 +- subcommands/create | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 625d7fa..e82ffc2 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ flags: - `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with - `-i|--image IMAGE`: the image name to start the service with - `-I|--image-version IMAGE_VERSION`: the image version to start the service with -- `-m|--memory MEMORY`: container memory limit (default: unlimited) +- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited) - `-p|--password PASSWORD`: override the user-level service password - `-r|--root-password PASSWORD`: override the root-level service password - `-s|--shm-size SHM_SIZE`: override shared memory size for mongo docker container @@ -442,7 +442,7 @@ flags: - `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with - `-i|--image IMAGE`: the image name to start the service with - `-I|--image-version IMAGE_VERSION`: the image version to start the service with -- `-m|--memory MEMORY`: container memory limit (default: unlimited) +- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited) - `-p|--password PASSWORD`: override the user-level service password - `-r|--root-password PASSWORD`: override the root-level service password - `-s|--shm-size SHM_SIZE`: override shared memory size for mongo docker container diff --git a/subcommands/clone b/subcommands/clone index e444478..3c5ff0b 100755 --- a/subcommands/clone +++ b/subcommands/clone @@ -14,7 +14,7 @@ service-clone-cmd() { #F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with #F -i|--image IMAGE, the image name to start the service with #F -I|--image-version IMAGE_VERSION, the image version to start the service with - #F -m|--memory MEMORY, container memory limit (default: unlimited) + #F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited) #F -p|--password PASSWORD, override the user-level service password #F -r|--root-password PASSWORD, override the root-level service password #F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container diff --git a/subcommands/create b/subcommands/create index a2f5ef5..557b8b8 100755 --- a/subcommands/create +++ b/subcommands/create @@ -22,7 +22,7 @@ service-create-cmd() { #F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with #F -i|--image IMAGE, the image name to start the service with #F -I|--image-version IMAGE_VERSION, the image version to start the service with - #F -m|--memory MEMORY, container memory limit (default: unlimited) + #F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited) #F -p|--password PASSWORD, override the user-level service password #F -r|--root-password PASSWORD, override the root-level service password #F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container