From 10e79999fc89da11d1c898e012f07e7570e9497f Mon Sep 17 00:00:00 2001 From: Emmanuel Averty Date: Wed, 13 Mar 2024 22:53:41 +0100 Subject: [PATCH] add documentation for gz/bz2/xz --- helpers/utils | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/helpers/utils b/helpers/utils index cc9341273..de42d9b22 100644 --- a/helpers/utils +++ b/helpers/utils @@ -97,6 +97,9 @@ fi # ```text # format = "tar.gz"/xz/bz2 # automatically guessed from the extension of the URL, but can be set explicitly. Will use `tar` to extract # "zip" # automatically guessed from the extension of the URL, but can be set explicitly. Will use `unzip` to extract +# "gz" # automatically guessed from the extension of the URL, but can be set explicitly. Will use `gunzip` to extract +# "bz2" # automatically guessed from the extension of the URL, but can be set explicitly. Will use `bunzip2` to extract +# "xz" # automatically guessed from the extension of the URL, but can be set explicitly. Will use `xz -d` to extract # "docker" # useful to extract files from an already-built docker image (instead of rebuilding them locally). Will use `docker-image-extract` to extract # "whatever" # an arbitrary value, not really meaningful except to imply that the file won't be extracted # @@ -104,11 +107,12 @@ fi # false # sources are directly in the archive root # n # (special cases) an integer representing a number of subdirs levels to get rid of # -# extract = true # default if file is indeed an archive such as .zip, .tar.gz, .tar.bz2, ... +# extract = true # default if file is indeed an archive such as .zip, .tar.gz, .tar.bz2, gz, ... # = false # default if file 'format' is not set and the file is not to be extracted because it is not an archive but a script or binary or whatever asset. # # in which case the file will only be `mv`ed to the location possibly renamed using the `rename` value # # rename = "whatever_your_want" # to be used for convenience when `extract` is false and the default name of the file is not practical +# # also used for single file archives (gz, bz2, xz) to rename the extracted file (default : the source id, or the app name for main source) # platform = "linux/amd64" # (defaults to "linux/$YNH_ARCH") to be used in conjonction with `format = "docker"` to specify which architecture to extract for # ``` #