blob: 02581c696e84191a74e0602679a67e510016ca43 [file] [log] [blame]
Roger Shimizu0a1f5332021-06-20 21:41:05 +09001.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
LaMont Jonesb750b482022-08-18 07:20:57 -04002.TH REPO "1" "October 2022" "repo gitc-init" "Repo Manual"
Roger Shimizu0a1f5332021-06-20 21:41:05 +09003.SH NAME
4repo \- repo gitc-init - manual page for repo gitc-init
5.SH SYNOPSIS
6.B repo
7\fI\,gitc-init \/\fR[\fI\,options\/\fR] [\fI\,client name\/\fR]
8.SH DESCRIPTION
9Summary
10.PP
11Initialize a GITC Client.
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
Roger Shimizu0a1f5332021-06-20 21:41:05 +090034\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
Mike Frysingere6601062021-11-12 01:41:29 -050044.TP
45\fB\-\-standalone\-manifest\fR
46download the manifest as a static file rather then
47create a git checkout of the manifest repo
LaMont Jonesb750b482022-08-18 07:20:57 -040048.TP
49\fB\-\-manifest\-depth\fR=\fI\,DEPTH\/\fR
50create a shallow clone of the manifest repo with given
51depth (0 for full clone); see git clone (default: 0)
Roger Shimizu0a1f5332021-06-20 21:41:05 +090052.SS Manifest (only) checkout options:
53.TP
54\fB\-\-current\-branch\fR
55fetch only current manifest branch from server
Mike Frysinger39cb17f2022-08-18 07:28:42 -040056(default)
Roger Shimizu0a1f5332021-06-20 21:41:05 +090057.TP
58\fB\-\-no\-current\-branch\fR
59fetch all manifest branches from server
60.TP
61\fB\-\-tags\fR
62fetch tags in the manifest
63.TP
64\fB\-\-no\-tags\fR
65don't fetch tags in the manifest
66.SS Checkout modes:
67.TP
68\fB\-\-mirror\fR
69create a replica of the remote repositories rather
70than a client working directory
71.TP
72\fB\-\-archive\fR
73checkout an archive instead of a git repository for
74each project. See git archive.
75.TP
76\fB\-\-worktree\fR
77use git\-worktree to manage projects
78.SS Project checkout optimizations:
79.TP
80\fB\-\-reference\fR=\fI\,DIR\/\fR
81location of mirror directory
82.TP
83\fB\-\-dissociate\fR
84dissociate from reference mirrors after clone
85.TP
86\fB\-\-depth\fR=\fI\,DEPTH\/\fR
87create a shallow clone with given depth; see git clone
88.TP
89\fB\-\-partial\-clone\fR
90perform partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code)
91.TP
92\fB\-\-no\-partial\-clone\fR
93disable use of partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code)
94.TP
95\fB\-\-partial\-clone\-exclude\fR=\fI\,PARTIAL_CLONE_EXCLUDE\/\fR
96exclude the specified projects (a comma\-delimited
97project names) from partial clone (https://gitscm.com/docs/gitrepositorylayout#_code_partialclone_code)
98.TP
99\fB\-\-clone\-filter\fR=\fI\,CLONE_FILTER\/\fR
100filter for use with \fB\-\-partial\-clone\fR [default:
101blob:none]
102.TP
103\fB\-\-use\-superproject\fR
Mike Frysingere6601062021-11-12 01:41:29 -0500104use the manifest superproject to sync projects;
105implies \fB\-c\fR
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900106.TP
107\fB\-\-no\-use\-superproject\fR
108disable use of manifest superprojects
109.TP
110\fB\-\-clone\-bundle\fR
111enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS (default if
112not \fB\-\-partial\-clone\fR)
113.TP
114\fB\-\-no\-clone\-bundle\fR
115disable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS (default if
116\fB\-\-partial\-clone\fR)
Mike Frysingerd47d9ff2022-07-10 05:15:19 -0400117.TP
118\fB\-\-git\-lfs\fR
119enable Git LFS support
120.TP
121\fB\-\-no\-git\-lfs\fR
122disable Git LFS support
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900123.SS repo Version options:
124.TP
125\fB\-\-repo\-url\fR=\fI\,URL\/\fR
126repo repository location ($REPO_URL)
127.TP
128\fB\-\-repo\-rev\fR=\fI\,REV\/\fR
129repo branch or revision ($REPO_REV)
130.TP
131\fB\-\-no\-repo\-verify\fR
132do not verify repo source code
133.SS Other options:
134.TP
135\fB\-\-config\-name\fR
136Always prompt for name/e\-mail
137.SS GITC options:
138.TP
139\fB\-f\fR MANIFEST_FILE, \fB\-\-manifest\-file\fR=\fI\,MANIFEST_FILE\/\fR
140Optional manifest file to use for this GITC client.
141.TP
142\fB\-c\fR GITC_CLIENT, \fB\-\-gitc\-client\fR=\fI\,GITC_CLIENT\/\fR
143Name of the gitc_client instance to create or modify.
Mike Frysingerd47d9ff2022-07-10 05:15:19 -0400144.SS Multi\-manifest:
145.TP
146\fB\-\-outer\-manifest\fR
147operate starting at the outermost manifest
148.TP
149\fB\-\-no\-outer\-manifest\fR
150do not operate on outer manifests
151.TP
152\fB\-\-this\-manifest\-only\fR
153only operate on this (sub)manifest
154.TP
155\fB\-\-no\-this\-manifest\-only\fR, \fB\-\-all\-manifests\fR
156operate on this manifest and its submanifests
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900157.PP
158Run `repo help gitc\-init` to view the detailed manual.
159.SH DETAILS
160.PP
161The 'repo gitc\-init' command is ran to initialize a new GITC client for use with
162the GITC file system.
163.PP
164This command will setup the client directory, initialize repo, just like repo
165init does, and then downloads the manifest collection and installs it in the
166\&.repo/directory of the GITC client.
167.PP
168Once this is done, a GITC manifest is generated by pulling the HEAD SHA for each
169project and generates the properly formatted XML file and installs it as
170\&.manifest in the GITC client directory.
171.PP
172The \fB\-c\fR argument is required to specify the GITC client name.
173.PP
174The optional \fB\-f\fR argument can be used to specify the manifest file to use for
175this GITC client.