summaryrefslogtreecommitdiffstats
path: root/man/repo-init.1
diff options
context:
space:
mode:
authorRoger Shimizu <rosh@debian.org>2021-06-20 21:41:05 +0900
committerMike Frysinger <vapier@google.com>2021-07-16 20:11:41 +0000
commit0a1f533e2835c856473e3e4046341a4d2f66764b (patch)
tree0902c039b76525f1c6785cec561df46265fdb787 /man/repo-init.1
parent927d29a8afa26a3f1aec841f2150c65e3931ef9b (diff)
downloadgit-repo-0a1f533e2835c856473e3e4046341a4d2f66764b.tar.gz
Add script 'release/update-manpages' to generate manpages
Debian package started to ship manpages for repo since 2.8 [1] And it's about for one year. So I think it should be upstreamed. The script depends on help2man, which is available in both debian [2] and ubuntu [3]. [1] https://tracker.debian.org/news/1150858/accepted-repo-28-1-source-into-unstable [2] https://tracker.debian.org/pkg/help2man [3] https://launchpad.net/ubuntu/+source/help2man Change-Id: Ide2b356d0944ebde34cc96c6d5a782655bd72288 Signed-off-by: Roger Shimizu <rosh@debian.org> Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/309782 Reviewed-by: Mike Frysinger <vapier@google.com>
Diffstat (limited to 'man/repo-init.1')
-rw-r--r--man/repo-init.1160
1 files changed, 160 insertions, 0 deletions
diff --git a/man/repo-init.1 b/man/repo-init.1
new file mode 100644
index 00000000..e860f95d
--- /dev/null
+++ b/man/repo-init.1
@@ -0,0 +1,160 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "July 2021" "repo init" "Repo Manual"
3.SH NAME
4repo \- repo init - manual page for repo init
5.SH SYNOPSIS
6.B repo
7\fI\,init \/\fR[\fI\,options\/\fR] [\fI\,manifest url\/\fR]
8.SH DESCRIPTION
9Summary
10.PP
11Initialize a repo client checkout in the current directory
12.SH OPTIONS
13.TP
14\fB\-h\fR, \fB\-\-help\fR
15show this help message and exit
16.SS Logging options:
17.TP
18\fB\-v\fR, \fB\-\-verbose\fR
19show all output
20.TP
21\fB\-q\fR, \fB\-\-quiet\fR
22only show errors
23.SS Manifest options:
24.TP
25\fB\-u\fR URL, \fB\-\-manifest\-url\fR=\fI\,URL\/\fR
26manifest repository location
27.TP
28\fB\-b\fR REVISION, \fB\-\-manifest\-branch\fR=\fI\,REVISION\/\fR
29manifest branch or revision (use HEAD for default)
30.TP
31\fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml
32initial manifest file
33.TP
34\fB\-g\fR GROUP, \fB\-\-groups\fR=\fI\,GROUP\/\fR
35restrict manifest projects to ones with specified
36group(s) [default|all|G1,G2,G3|G4,\-G5,\-G6]
37.TP
38\fB\-p\fR PLATFORM, \fB\-\-platform\fR=\fI\,PLATFORM\/\fR
39restrict manifest projects to ones with a specified
40platform group [auto|all|none|linux|darwin|...]
41.TP
42\fB\-\-submodules\fR
43sync any submodules associated with the manifest repo
44.SS Manifest (only) checkout options:
45.TP
46\fB\-c\fR, \fB\-\-current\-branch\fR
47fetch only current manifest branch from server
48.TP
49\fB\-\-no\-current\-branch\fR
50fetch all manifest branches from server
51.TP
52\fB\-\-tags\fR
53fetch tags in the manifest
54.TP
55\fB\-\-no\-tags\fR
56don't fetch tags in the manifest
57.SS Checkout modes:
58.TP
59\fB\-\-mirror\fR
60create a replica of the remote repositories rather
61than a client working directory
62.TP
63\fB\-\-archive\fR
64checkout an archive instead of a git repository for
65each project. See git archive.
66.TP
67\fB\-\-worktree\fR
68use git\-worktree to manage projects
69.SS Project checkout optimizations:
70.TP
71\fB\-\-reference\fR=\fI\,DIR\/\fR
72location of mirror directory
73.TP
74\fB\-\-dissociate\fR
75dissociate from reference mirrors after clone
76.TP
77\fB\-\-depth\fR=\fI\,DEPTH\/\fR
78create a shallow clone with given depth; see git clone
79.TP
80\fB\-\-partial\-clone\fR
81perform partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code)
82.TP
83\fB\-\-no\-partial\-clone\fR
84disable use of partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code)
85.TP
86\fB\-\-partial\-clone\-exclude\fR=\fI\,PARTIAL_CLONE_EXCLUDE\/\fR
87exclude the specified projects (a comma\-delimited
88project names) from partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code)
89.TP
90\fB\-\-clone\-filter\fR=\fI\,CLONE_FILTER\/\fR
91filter for use with \fB\-\-partial\-clone\fR [default:
92blob:none]
93.TP
94\fB\-\-use\-superproject\fR
95use the manifest superproject to sync projects
96.TP
97\fB\-\-no\-use\-superproject\fR
98disable use of manifest superprojects
99.TP
100\fB\-\-clone\-bundle\fR
101enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS (default if
102not \fB\-\-partial\-clone\fR)
103.TP
104\fB\-\-no\-clone\-bundle\fR
105disable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS (default if
106\fB\-\-partial\-clone\fR)
107.SS repo Version options:
108.TP
109\fB\-\-repo\-url\fR=\fI\,URL\/\fR
110repo repository location ($REPO_URL)
111.TP
112\fB\-\-repo\-rev\fR=\fI\,REV\/\fR
113repo branch or revision ($REPO_REV)
114.TP
115\fB\-\-no\-repo\-verify\fR
116do not verify repo source code
117.SS Other options:
118.TP
119\fB\-\-config\-name\fR
120Always prompt for name/e\-mail
121.PP
122Run `repo help init` to view the detailed manual.
123.SH DETAILS
124.PP
125The 'repo init' command is run once to install and initialize repo. The latest
126repo source code and manifest collection is downloaded from the server and is
127installed in the .repo/ directory in the current working directory.
128.PP
129When creating a new checkout, the manifest URL is the only required setting. It
130may be specified using the \fB\-\-manifest\-url\fR option, or as the first optional
131argument.
132.PP
133The optional \fB\-b\fR argument can be used to select the manifest branch to checkout
134and use. If no branch is specified, the remote's default branch is used. This is
135equivalent to using \fB\-b\fR HEAD.
136.PP
137The optional \fB\-m\fR argument can be used to specify an alternate manifest to be
138used. If no manifest is specified, the manifest default.xml will be used.
139.PP
140The \fB\-\-reference\fR option can be used to point to a directory that has the content
141of a \fB\-\-mirror\fR sync. This will make the working directory use as much data as
142possible from the local reference directory when fetching from the server. This
143will make the sync go a lot faster by reducing data traffic on the network.
144.PP
145The \fB\-\-dissociate\fR option can be used to borrow the objects from the directory
146specified with the \fB\-\-reference\fR option only to reduce network transfer, and stop
147borrowing from them after a first clone is made by making necessary local copies
148of borrowed objects.
149.PP
150The \fB\-\-no\-clone\-bundle\fR option disables any attempt to use \fI\,$URL/clone.bundle\/\fP to
151bootstrap a new Git repository from a resumeable bundle file on a content
152delivery network. This may be necessary if there are problems with the local
153Python HTTP client or proxy configuration, but the Git binary works.
154.PP
155Switching Manifest Branches
156.PP
157To switch to another manifest branch, `repo init \fB\-b\fR otherbranch` may be used in
158an existing client. However, as this only updates the manifest, a subsequent
159`repo sync` (or `repo sync \fB\-d\fR`) is necessary to update the working directory
160files.