blob: f0cfb6eaa20b9cf6d7a8664b9a87f7bd07de1fe3 [file] [log] [blame]
dnj@chromium.orgde219ec2014-07-28 17:39:08 +00001'\" t
2.\" Title: git-retry
3.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
Quinten Yearsley442fb642016-12-15 15:38:27 -08005.\" Date: 12/15/2016
dnj@chromium.orgde219ec2014-07-28 17:39:08 +00006.\" Manual: Chromium depot_tools Manual
Quinten Yearsley442fb642016-12-15 15:38:27 -08007.\" Source: depot_tools f72f1ad
dnj@chromium.orgde219ec2014-07-28 17:39:08 +00008.\" Language: English
9.\"
Quinten Yearsley442fb642016-12-15 15:38:27 -080010.TH "GIT\-RETRY" "1" "12/15/2016" "depot_tools f72f1ad" "Chromium depot_tools Manual"
dnj@chromium.orgde219ec2014-07-28 17:39:08 +000011.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31git-retry \- Bootstrap function to retry a git command\&.
32.SH "SYNOPSIS"
33.sp
34.nf
estaabf1fcda42016-09-03 18:19:52 -070035\fIgit retry\fR [\-v] [\-c COUNT] [\-d DELAY] [\-D DELAY_FACTOR] \(em \fI<git_subcommand>\fR
dnj@chromium.orgde219ec2014-07-28 17:39:08 +000036.fi
37.sp
38.SH "DESCRIPTION"
39.sp
40git retry is a bootstrap that wraps a standard git command execution in a fault\-tolerant retry wrapper\&.
41.sp
42If a retry succeeds, the return code of the successful attempt is returned\&. Otherwise, the return code of the last failed attempt is returned\&.
43.sp
44The wrapper is aware of git\-specific failure conditions and will only consider retrying if a given failure can be linked to such a condition\&.
45.SH "OPTIONS"
46.PP
47<git_subcommand>
48.RS 4
49The
50git
51command to retry\&. This should omit the actual
52git
53command (e\&.g\&., to retry
54git clone, use
55git retry clone)\&.
56.RE
57.PP
58\-v, \-\-verbose
59.RS 4
60Increases logging verbosity\&. By default, no additional logging is generated by the
61git retry
62command\&. This can be specified multiple times\&.
63.RE
64.PP
65\-c, \-\-retry\-count \fIcount\fR
66.RS 4
67Specify the number of retries that should be performed before giving up\&. The default retry count is
68\fB5\fR\&.
69.RE
70.PP
71\-d, \-\-delay \fIseconds\fR
72.RS 4
73Floating\-point value that specifies the amount of time (in seconds) to wait after a failure\&. This can be zero to specify no delay\&. The default delay is
74\fB3 seconds\fR\&.
75.RE
76.PP
77\-D, \-\-delay\-factor
78.RS 4
79The exponential factor to apply to the delay\&. By default this is
80\fB2\fR\&. For a given retry round
81\fBn\fR, the delay for that round will be
82\fB(<delay\-factor>^(n\-1) * delay)\fR\&. If no delay is specified, this will have no effect\&. If the delay factor is
83\fB0\fR, the delay will increase linearly (for a given retry round
84\fBn\fR, the delay will be
85\fB(n * delay)\fR)\&.
86.sp
87.if n \{\
88.RS 4
89.\}
90.nf
91(Note that a delay factor of *1* will result in a constant delay\&.)
92.fi
93.if n \{\
94.RE
95.\}
96.RE
97.SH "EXIT STATUS"
98.sp
99Upon success, git retry will exit with the successful exit code of \fB0\fR\&. On failure, it will exit with the exit code of the last failed attempt\&.
100.SH "CHROMIUM DEPOT_TOOLS"
101.sp
102Part of the chromium \fBdepot_tools\fR(7) suite\&. These tools are meant to assist with the development of chromium and related projects\&. Download the tools from \m[blue]\fBhere\fR\m[]\&\s-2\u[1]\d\s+2\&.
103.SH "NOTES"
104.IP " 1." 4
105here
106.RS 4
estaabf1fcda42016-09-03 18:19:52 -0700107\%https://chromium.googlesource.com/chromium/tools/depot_tools.git
dnj@chromium.orgde219ec2014-07-28 17:39:08 +0000108.RE