Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
chevdor committed Nov 4, 2021
1 parent 866a270 commit bb5daa3
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 20 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <chevdor@gmail.com>
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:
Expand All @@ -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 <image> Chose an alternative image. Beware to chose an image that is compatible
-i, --image <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
Expand All @@ -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 <chevdor@gmail.com>
Show the versions of the srtool container. Use --version if you want the version of this executable

Expand All @@ -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 <chevdor@gmail.com>
Provide information about the srtool container and your repo

Expand All @@ -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 <chevdor@gmail.com>
Simply pull the srtool image and do not run anything else

Expand All @@ -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 <chevdor@gmail.com>
Start a new srtool container to build your runtime

Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions doc/usage.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
srtool-cli 0.6.0
srtool-cli 0.7.1
chevdor <chevdor@gmail.com>
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:
Expand All @@ -14,10 +14,10 @@ FLAGS:
-V, --version Prints version information

OPTIONS:
-i, --image <image> Chose an alternative image. Beware to chose an image that is compatible
-i, --image <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
Expand Down
6 changes: 3 additions & 3 deletions doc/usage_build.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
srtool-build 0.6.0
srtool-build 0.7.1
chevdor <chevdor@gmail.com>
Start a new srtool container to build your runtime

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/usage_info.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
srtool-info 0.6.0
srtool-info 0.7.1
chevdor <chevdor@gmail.com>
Provide information about the srtool container and your repo

Expand Down
2 changes: 1 addition & 1 deletion doc/usage_pull.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
srtool-pull 0.6.0
srtool-pull 0.7.1
chevdor <chevdor@gmail.com>
Simply pull the srtool image and do not run anything else

Expand Down
2 changes: 1 addition & 1 deletion doc/usage_version.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
srtool-version 0.6.0
srtool-version 0.7.1
chevdor <chevdor@gmail.com>
Show the versions of the srtool container. Use --version if you want the version of this executable

Expand Down

0 comments on commit bb5daa3

Please sign in to comment.