blob: 6d99aa01c15b9aeaa1c3eadd724806de3ec24c30 [file] [log] [blame]
.\" Man page generated from reStructuredText.
.
.TH GROK-BUNDLE 1 "2020-09-04" "2.0.0" ""
.SH NAME
GROK-BUNDLE \- Create clone.bundle files for use with "repo"
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
grok\-bundle [options] \-c grokmirror.conf \-o path
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
Android\(aqs "repo" tool will check for the presence of clone.bundle files
before performing a fresh git clone. This is done in order to offload
most of the git traffic to a CDN and reduce the load on git servers
themselves.
.sp
This command will generate clone.bundle files in a hierarchy expected by
repo. You can then sync the output directory to a CDN service.
.SH OPTIONS
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.B \-v\fP,\fB \-\-verbose
Be verbose and tell us what you are doing (default: False)
.TP
.BI \-c \ CONFIG\fP,\fB \ \-\-config \ CONFIG
Location of the configuration file
.TP
.BI \-o \ OUTDIR\fP,\fB \ \-\-outdir \ OUTDIR
Location where to store bundle files
.TP
.BI \-g \ GITARGS\fP,\fB \ \-\-gitargs \ GITARGS
extra args to pass to git (default: \-c core.compression=9)
.TP
.BI \-r \ REVLISTARGS\fP,\fB \ \-\-revlistargs \ REVLISTARGS
Rev\-list args to use (default: \-\-branches HEAD)
.TP
.BI \-s \ MAXSIZE\fP,\fB \ \-\-maxsize \ MAXSIZE
Maximum size of git repositories to bundle (in GiB) (default: 2)
.TP
.BI \-i\fP,\fB \-\-include \ INCLUDE
List repositories to bundle (accepts shell globbing) (default: *)
.UNINDENT
.UNINDENT
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
grok\-bundle \-c grokmirror.conf \-o /var/www/bundles \-i /pub/scm/linux/kernel/git/torvalds/linux.git /pub/scm/linux/kernel/git/stable/linux.git /pub/scm/linux/kernel/git/next/linux\-next.git
.UNINDENT
.UNINDENT
.SH SEE ALSO
.INDENT 0.0
.IP \(bu 2
grok\-pull(1)
.IP \(bu 2
grok\-manifest(1)
.IP \(bu 2
grok\-fsck(1)
.IP \(bu 2
git(1)
.UNINDENT
.SH SUPPORT
.sp
Email \fI\%tools@linux.kernel.org\fP\&.
.SH AUTHOR
mricon@kernel.org
License: GPLv3+
.SH COPYRIGHT
The Linux Foundation and contributors
.\" Generated by docutils manpage writer.
.