diff options
Diffstat (limited to 'man/repo-init.1')
-rw-r--r-- | man/repo-init.1 | 160 |
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 | ||
4 | repo \- 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 | ||
9 | Summary | ||
10 | .PP | ||
11 | Initialize a repo client checkout in the current directory | ||
12 | .SH OPTIONS | ||
13 | .TP | ||
14 | \fB\-h\fR, \fB\-\-help\fR | ||
15 | show this help message and exit | ||
16 | .SS Logging options: | ||
17 | .TP | ||
18 | \fB\-v\fR, \fB\-\-verbose\fR | ||
19 | show all output | ||
20 | .TP | ||
21 | \fB\-q\fR, \fB\-\-quiet\fR | ||
22 | only show errors | ||
23 | .SS Manifest options: | ||
24 | .TP | ||
25 | \fB\-u\fR URL, \fB\-\-manifest\-url\fR=\fI\,URL\/\fR | ||
26 | manifest repository location | ||
27 | .TP | ||
28 | \fB\-b\fR REVISION, \fB\-\-manifest\-branch\fR=\fI\,REVISION\/\fR | ||
29 | manifest branch or revision (use HEAD for default) | ||
30 | .TP | ||
31 | \fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml | ||
32 | initial manifest file | ||
33 | .TP | ||
34 | \fB\-g\fR GROUP, \fB\-\-groups\fR=\fI\,GROUP\/\fR | ||
35 | restrict manifest projects to ones with specified | ||
36 | group(s) [default|all|G1,G2,G3|G4,\-G5,\-G6] | ||
37 | .TP | ||
38 | \fB\-p\fR PLATFORM, \fB\-\-platform\fR=\fI\,PLATFORM\/\fR | ||
39 | restrict manifest projects to ones with a specified | ||
40 | platform group [auto|all|none|linux|darwin|...] | ||
41 | .TP | ||
42 | \fB\-\-submodules\fR | ||
43 | sync any submodules associated with the manifest repo | ||
44 | .SS Manifest (only) checkout options: | ||
45 | .TP | ||
46 | \fB\-c\fR, \fB\-\-current\-branch\fR | ||
47 | fetch only current manifest branch from server | ||
48 | .TP | ||
49 | \fB\-\-no\-current\-branch\fR | ||
50 | fetch all manifest branches from server | ||
51 | .TP | ||
52 | \fB\-\-tags\fR | ||
53 | fetch tags in the manifest | ||
54 | .TP | ||
55 | \fB\-\-no\-tags\fR | ||
56 | don't fetch tags in the manifest | ||
57 | .SS Checkout modes: | ||
58 | .TP | ||
59 | \fB\-\-mirror\fR | ||
60 | create a replica of the remote repositories rather | ||
61 | than a client working directory | ||
62 | .TP | ||
63 | \fB\-\-archive\fR | ||
64 | checkout an archive instead of a git repository for | ||
65 | each project. See git archive. | ||
66 | .TP | ||
67 | \fB\-\-worktree\fR | ||
68 | use git\-worktree to manage projects | ||
69 | .SS Project checkout optimizations: | ||
70 | .TP | ||
71 | \fB\-\-reference\fR=\fI\,DIR\/\fR | ||
72 | location of mirror directory | ||
73 | .TP | ||
74 | \fB\-\-dissociate\fR | ||
75 | dissociate from reference mirrors after clone | ||
76 | .TP | ||
77 | \fB\-\-depth\fR=\fI\,DEPTH\/\fR | ||
78 | create a shallow clone with given depth; see git clone | ||
79 | .TP | ||
80 | \fB\-\-partial\-clone\fR | ||
81 | perform partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code) | ||
82 | .TP | ||
83 | \fB\-\-no\-partial\-clone\fR | ||
84 | disable 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 | ||
87 | exclude the specified projects (a comma\-delimited | ||
88 | project names) from partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code) | ||
89 | .TP | ||
90 | \fB\-\-clone\-filter\fR=\fI\,CLONE_FILTER\/\fR | ||
91 | filter for use with \fB\-\-partial\-clone\fR [default: | ||
92 | blob:none] | ||
93 | .TP | ||
94 | \fB\-\-use\-superproject\fR | ||
95 | use the manifest superproject to sync projects | ||
96 | .TP | ||
97 | \fB\-\-no\-use\-superproject\fR | ||
98 | disable use of manifest superprojects | ||
99 | .TP | ||
100 | \fB\-\-clone\-bundle\fR | ||
101 | enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS (default if | ||
102 | not \fB\-\-partial\-clone\fR) | ||
103 | .TP | ||
104 | \fB\-\-no\-clone\-bundle\fR | ||
105 | disable 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 | ||
110 | repo repository location ($REPO_URL) | ||
111 | .TP | ||
112 | \fB\-\-repo\-rev\fR=\fI\,REV\/\fR | ||
113 | repo branch or revision ($REPO_REV) | ||
114 | .TP | ||
115 | \fB\-\-no\-repo\-verify\fR | ||
116 | do not verify repo source code | ||
117 | .SS Other options: | ||
118 | .TP | ||
119 | \fB\-\-config\-name\fR | ||
120 | Always prompt for name/e\-mail | ||
121 | .PP | ||
122 | Run `repo help init` to view the detailed manual. | ||
123 | .SH DETAILS | ||
124 | .PP | ||
125 | The 'repo init' command is run once to install and initialize repo. The latest | ||
126 | repo source code and manifest collection is downloaded from the server and is | ||
127 | installed in the .repo/ directory in the current working directory. | ||
128 | .PP | ||
129 | When creating a new checkout, the manifest URL is the only required setting. It | ||
130 | may be specified using the \fB\-\-manifest\-url\fR option, or as the first optional | ||
131 | argument. | ||
132 | .PP | ||
133 | The optional \fB\-b\fR argument can be used to select the manifest branch to checkout | ||
134 | and use. If no branch is specified, the remote's default branch is used. This is | ||
135 | equivalent to using \fB\-b\fR HEAD. | ||
136 | .PP | ||
137 | The optional \fB\-m\fR argument can be used to specify an alternate manifest to be | ||
138 | used. If no manifest is specified, the manifest default.xml will be used. | ||
139 | .PP | ||
140 | The \fB\-\-reference\fR option can be used to point to a directory that has the content | ||
141 | of a \fB\-\-mirror\fR sync. This will make the working directory use as much data as | ||
142 | possible from the local reference directory when fetching from the server. This | ||
143 | will make the sync go a lot faster by reducing data traffic on the network. | ||
144 | .PP | ||
145 | The \fB\-\-dissociate\fR option can be used to borrow the objects from the directory | ||
146 | specified with the \fB\-\-reference\fR option only to reduce network transfer, and stop | ||
147 | borrowing from them after a first clone is made by making necessary local copies | ||
148 | of borrowed objects. | ||
149 | .PP | ||
150 | The \fB\-\-no\-clone\-bundle\fR option disables any attempt to use \fI\,$URL/clone.bundle\/\fP to | ||
151 | bootstrap a new Git repository from a resumeable bundle file on a content | ||
152 | delivery network. This may be necessary if there are problems with the local | ||
153 | Python HTTP client or proxy configuration, but the Git binary works. | ||
154 | .PP | ||
155 | Switching Manifest Branches | ||
156 | .PP | ||
157 | To switch to another manifest branch, `repo init \fB\-b\fR otherbranch` may be used in | ||
158 | an 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 | ||
160 | files. | ||