Index: man/src/git-retry.txt |
diff --git a/man/src/git-retry.txt b/man/src/git-retry.txt |
new file mode 100644 |
index 0000000000000000000000000000000000000000..bbd7692ea2ed8a2b4a6c689d70b68ef1ddf389f5 |
--- /dev/null |
+++ b/man/src/git-retry.txt |
@@ -0,0 +1,60 @@ |
+git-retry(1) |
+============= |
+ |
+NAME |
+---- |
+git-retry - |
+include::_git-retry_desc.helper.txt[] |
+ |
+SYNOPSIS |
+-------- |
+[verse] |
+'git retry' [-v] [-c COUNT] [-d DELAY] [-e] -- _<git_subcommand>_ |
+ |
+DESCRIPTION |
+----------- |
+ |
+`git retry` is a bootstrap that wraps a standard `git` command execution in |
+a fault-tolerant retry wrapper. |
+ |
+If a retry succeeds, the return code of the successful attempt is returned. |
+Otherwise, the return code of the last failed attempt is returned. |
+ |
+The wrapper is aware of `git`-specific failure conditions and will only consider |
+retrying if a given failure can be linked to such a condition. |
+ |
+ |
+OPTIONS |
+------- |
+ |
+<git_subcommand>:: |
+ The `git` command to retry. This should omit the actual `git` command (e.g., |
+ to retry `git clone`, use `git retry clone`). |
+ |
+-v, --verbose:: |
+ Increases logging verbosity. By default, no additional logging is generated |
+ by the `git retry` command. This can be specified multiple times. |
+ |
+-c, --retry-count _count_:: |
+ Specify the number of retries that should be performed before giving up. |
+ |
+-d, --delay _seconds_:: |
+ If specified, the time delta to wait in between retry attempts. By default, |
+ retries will happen immediately after failures. This can be used to introduce |
+ a delay. |
+ |
+-e, --delay-exponential:: |
+ If specified, the retry delay will double with each retry. Note that if no |
+ delay is specified, this will have no effect. |
+ |
+ |
+EXIT STATUS |
+----------- |
+ |
+Upon success, `git retry` will exit with the successful exit code of *0*. On |
+failure, it will exit with the exit code of the last failed attempt. |
+ |
+ |
+include::_footer.txt[] |
+ |
+// vim: ft=asciidoc: |