diff --git a/README.md b/README.md index d4fee2b..1bc0497 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ This alias is likely set in your `.bash_profile` or `.zshrc`, make sure to remov **help** - srtool-cli 0.6.0 + srtool-cli 0.7.1 chevdor This utility helps starting a container from the srtool Docker image. It passes the right parameters and environment variables to the container. Learn more about the srtool image here: @@ -47,10 +47,10 @@ This alias is likely set in your `.bash_profile` or `.zshrc`, make sure to remov -V, --version Prints version information OPTIONS: - -i, --image Chose an alternative image. Beware to chose an image that is compatible + -i, --image Choose an alternative image. Beware to choose an image that is compatible with the original srtool image. Using a random image, you take the risk - to NOT produce exactly the same deterministic result than srtool - [default: paritytech/srtool] + to NOT produce exactly the same deterministic result as srtool [default: + paritytech/srtool] SUBCOMMANDS: build Start a new srtool container to build your runtime @@ -62,7 +62,7 @@ This alias is likely set in your `.bash_profile` or `.zshrc`, make sure to remov **version** - srtool-version 0.6.0 + srtool-version 0.7.1 chevdor Show the versions of the srtool container. Use --version if you want the version of this executable @@ -75,7 +75,7 @@ This alias is likely set in your `.bash_profile` or `.zshrc`, make sure to remov **info** - srtool-info 0.6.0 + srtool-info 0.7.1 chevdor Provide information about the srtool container and your repo @@ -99,7 +99,7 @@ This alias is likely set in your `.bash_profile` or `.zshrc`, make sure to remov **pull** - srtool-pull 0.6.0 + srtool-pull 0.7.1 chevdor Simply pull the srtool image and do not run anything else @@ -112,7 +112,7 @@ This alias is likely set in your `.bash_profile` or `.zshrc`, make sure to remov **build** - srtool-build 0.6.0 + srtool-build 0.7.1 chevdor Start a new srtool container to build your runtime @@ -124,12 +124,12 @@ This alias is likely set in your `.bash_profile` or `.zshrc`, make sure to remov another location, you can pass it here [default: .] FLAGS: - -a, --app Enable the "app" mode which is a mix of json output and outputing progress + -a, --app Enable the "app" mode which is a mix of json output and outputting progress during the build. This flag is recommended for CI. the json output will be provided as a single line at the end in compact mode -h, --help Prints help information -j, --json Enable json output, same than the global --json option - --no-cache Passsing this flag allows completely disabling caching. As a result, no cargo- + --no-cache Passing this flag allows completely disabling caching. As a result, no cargo- home will be mounted to the srtool image. There is no known issue with having the cache ON, this is why it is the default -V, --version Prints version information diff --git a/doc/usage.adoc b/doc/usage.adoc index 1325986..d53991c 100644 --- a/doc/usage.adoc +++ b/doc/usage.adoc @@ -1,4 +1,4 @@ -srtool-cli 0.6.0 +srtool-cli 0.7.1 chevdor This utility helps starting a container from the srtool Docker image. It passes the right parameters and environment variables to the container. Learn more about the srtool image here: @@ -14,10 +14,10 @@ FLAGS: -V, --version Prints version information OPTIONS: - -i, --image Chose an alternative image. Beware to chose an image that is compatible + -i, --image Choose an alternative image. Beware to choose an image that is compatible with the original srtool image. Using a random image, you take the risk - to NOT produce exactly the same deterministic result than srtool - [default: paritytech/srtool] + to NOT produce exactly the same deterministic result as srtool [default: + paritytech/srtool] SUBCOMMANDS: build Start a new srtool container to build your runtime diff --git a/doc/usage_build.adoc b/doc/usage_build.adoc index 1a18abf..be7e28b 100644 --- a/doc/usage_build.adoc +++ b/doc/usage_build.adoc @@ -1,4 +1,4 @@ -srtool-build 0.6.0 +srtool-build 0.7.1 chevdor Start a new srtool container to build your runtime @@ -10,12 +10,12 @@ ARGS: another location, you can pass it here [default: .] FLAGS: - -a, --app Enable the "app" mode which is a mix of json output and outputing progress + -a, --app Enable the "app" mode which is a mix of json output and outputting progress during the build. This flag is recommended for CI. the json output will be provided as a single line at the end in compact mode -h, --help Prints help information -j, --json Enable json output, same than the global --json option - --no-cache Passsing this flag allows completely disabling caching. As a result, no cargo- + --no-cache Passing this flag allows completely disabling caching. As a result, no cargo- home will be mounted to the srtool image. There is no known issue with having the cache ON, this is why it is the default -V, --version Prints version information diff --git a/doc/usage_info.adoc b/doc/usage_info.adoc index 45ef2f4..d0d17c1 100644 --- a/doc/usage_info.adoc +++ b/doc/usage_info.adoc @@ -1,4 +1,4 @@ -srtool-info 0.6.0 +srtool-info 0.7.1 chevdor Provide information about the srtool container and your repo diff --git a/doc/usage_pull.adoc b/doc/usage_pull.adoc index adc5061..0ac4b0c 100644 --- a/doc/usage_pull.adoc +++ b/doc/usage_pull.adoc @@ -1,4 +1,4 @@ -srtool-pull 0.6.0 +srtool-pull 0.7.1 chevdor Simply pull the srtool image and do not run anything else diff --git a/doc/usage_version.adoc b/doc/usage_version.adoc index 90513b3..2e62abf 100644 --- a/doc/usage_version.adoc +++ b/doc/usage_version.adoc @@ -1,4 +1,4 @@ -srtool-version 0.6.0 +srtool-version 0.7.1 chevdor Show the versions of the srtool container. Use --version if you want the version of this executable