Skip to content

Commit

Permalink
chore: adjust doc comment about the effect of volume mount functions
Browse files Browse the repository at this point in the history
Signed-off-by: Nathan Nguyen <[email protected]>
  • Loading branch information
nathanwn committed Oct 25, 2023
1 parent 8033065 commit 1f00686
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions scripts/release_scripts/run_macaron.sh
Original file line number Diff line number Diff line change
Expand Up @@ -141,16 +141,14 @@ function create_dir_if_not_exists() {
fi
}

# Add a directory to the list of volume mounts.
# Add a directory to the list of volume mounts stored in the ``mounts`` global variable.
#
# Arguments:
# $1: The macaron argument from which the directory is passed into this script.
# $2: The path to the directory on the host.
# $3: The path to the directory inside the container.
# $4: Mount option. Note: this MUST be either `ro,Z` for readonly volume mounts,
# or `rw,Z` otherwise.
# Globals:
# mounts: the volume mount is added to this array
function mount_dir() {
arg_name=$1
dir_on_host=$2
Expand All @@ -172,16 +170,14 @@ function mount_dir() {
mounts+=("-v" "${dir_on_host}:${dir_in_container}:${mount_option}")
}

# Add a file to the list of volume mounts.
# Add a file to the list of volume mounts stored in the ``mounts`` global variable.
#
# Arguments:
# $1: The macaron argument from which the file is passed into this script.
# $2: The path to the file on the host.
# $3: The path to the file inside the container.
# $4: Mount option. Note: this MUST be either `ro,Z` for readonly volumes,
# or `rw,Z` otherwise.
# Globals:
# mounts: the volume mount is added to this array
function mount_file() {
arg_name=$1
file_on_host=$2
Expand Down

0 comments on commit 1f00686

Please sign in to comment.