summaryrefslogtreecommitdiffstats
path: root/man/repo-gitc-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-gitc-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-gitc-init.1')
-rw-r--r--man/repo-gitc-init.1146
1 files changed, 146 insertions, 0 deletions
diff --git a/man/repo-gitc-init.1 b/man/repo-gitc-init.1
new file mode 100644
index 00000000..1d1b23a8
--- /dev/null
+++ b/man/repo-gitc-init.1
@@ -0,0 +1,146 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "July 2021" "repo gitc-init" "Repo Manual"
3.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
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\-\-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.SS GITC options:
122.TP
123\fB\-f\fR MANIFEST_FILE, \fB\-\-manifest\-file\fR=\fI\,MANIFEST_FILE\/\fR
124Optional manifest file to use for this GITC client.
125.TP
126\fB\-c\fR GITC_CLIENT, \fB\-\-gitc\-client\fR=\fI\,GITC_CLIENT\/\fR
127Name of the gitc_client instance to create or modify.
128.PP
129Run `repo help gitc\-init` to view the detailed manual.
130.SH DETAILS
131.PP
132The 'repo gitc\-init' command is ran to initialize a new GITC client for use with
133the GITC file system.
134.PP
135This command will setup the client directory, initialize repo, just like repo
136init does, and then downloads the manifest collection and installs it in the
137\&.repo/directory of the GITC client.
138.PP
139Once this is done, a GITC manifest is generated by pulling the HEAD SHA for each
140project and generates the properly formatted XML file and installs it as
141\&.manifest in the GITC client directory.
142.PP
143The \fB\-c\fR argument is required to specify the GITC client name.
144.PP
145The optional \fB\-f\fR argument can be used to specify the manifest file to use for
146this GITC client.