summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--man/repo-gitc-delete.144
-rw-r--r--man/repo-gitc-init.1175
-rw-r--r--man/repo-manifest.130
-rw-r--r--man/repo-smartsync.17
-rw-r--r--man/repo-sync.112
-rw-r--r--man/repo-upload.111
-rw-r--r--man/repo.18
7 files changed, 51 insertions, 236 deletions
diff --git a/man/repo-gitc-delete.1 b/man/repo-gitc-delete.1
deleted file mode 100644
index 6158bd3b..00000000
--- a/man/repo-gitc-delete.1
+++ /dev/null
@@ -1,44 +0,0 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "July 2022" "repo gitc-delete" "Repo Manual"
3.SH NAME
4repo \- repo gitc-delete - manual page for repo gitc-delete
5.SH SYNOPSIS
6.B repo
7\fI\,gitc-delete\/\fR
8.SH DESCRIPTION
9Summary
10.PP
11Delete a GITC Client.
12.SH OPTIONS
13.TP
14\fB\-h\fR, \fB\-\-help\fR
15show this help message and exit
16.TP
17\fB\-f\fR, \fB\-\-force\fR
18force the deletion (no prompt)
19.SS Logging options:
20.TP
21\fB\-v\fR, \fB\-\-verbose\fR
22show all output
23.TP
24\fB\-q\fR, \fB\-\-quiet\fR
25only show errors
26.SS Multi\-manifest options:
27.TP
28\fB\-\-outer\-manifest\fR
29operate starting at the outermost manifest
30.TP
31\fB\-\-no\-outer\-manifest\fR
32do not operate on outer manifests
33.TP
34\fB\-\-this\-manifest\-only\fR
35only operate on this (sub)manifest
36.TP
37\fB\-\-no\-this\-manifest\-only\fR, \fB\-\-all\-manifests\fR
38operate on this manifest and its submanifests
39.PP
40Run `repo help gitc\-delete` to view the detailed manual.
41.SH DETAILS
42.PP
43This subcommand deletes the current GITC client, deleting the GITC manifest and
44all locally downloaded sources.
diff --git a/man/repo-gitc-init.1 b/man/repo-gitc-init.1
deleted file mode 100644
index 02581c69..00000000
--- a/man/repo-gitc-init.1
+++ /dev/null
@@ -1,175 +0,0 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "October 2022" "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.TP
45\fB\-\-standalone\-manifest\fR
46download the manifest as a static file rather then
47create a git checkout of the manifest repo
48.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)
52.SS Manifest (only) checkout options:
53.TP
54\fB\-\-current\-branch\fR
55fetch only current manifest branch from server
56(default)
57.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
104use the manifest superproject to sync projects;
105implies \fB\-c\fR
106.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)
117.TP
118\fB\-\-git\-lfs\fR
119enable Git LFS support
120.TP
121\fB\-\-no\-git\-lfs\fR
122disable Git LFS support
123.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.
144.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
157.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.
diff --git a/man/repo-manifest.1 b/man/repo-manifest.1
index e49836ca..10ec2e75 100644
--- a/man/repo-manifest.1
+++ b/man/repo-manifest.1
@@ -1,5 +1,5 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man. 1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "October 2022" "repo manifest" "Repo Manual" 2.TH REPO "1" "April 2024" "repo manifest" "Repo Manual"
3.SH NAME 3.SH NAME
4repo \- repo manifest - manual page for repo manifest 4repo \- repo manifest - manual page for repo manifest
5.SH SYNOPSIS 5.SH SYNOPSIS
@@ -194,8 +194,9 @@ CDATA #IMPLIED>
194<!ATTLIST extend\-project upstream CDATA #IMPLIED> 194<!ATTLIST extend\-project upstream CDATA #IMPLIED>
195.IP 195.IP
196<!ELEMENT remove\-project EMPTY> 196<!ELEMENT remove\-project EMPTY>
197<!ATTLIST remove\-project name CDATA #REQUIRED> 197<!ATTLIST remove\-project name CDATA #IMPLIED>
198<!ATTLIST remove\-project optional CDATA #IMPLIED> 198<!ATTLIST remove\-project path CDATA #IMPLIED>
199<!ATTLIST remove\-project optional CDATA #IMPLIED>
199.IP 200.IP
200<!ELEMENT repo\-hooks EMPTY> 201<!ELEMENT repo\-hooks EMPTY>
201<!ATTLIST repo\-hooks in\-project CDATA #REQUIRED> 202<!ATTLIST repo\-hooks in\-project CDATA #REQUIRED>
@@ -210,8 +211,9 @@ CDATA #IMPLIED>
210<!ATTLIST contactinfo bugurl CDATA #REQUIRED> 211<!ATTLIST contactinfo bugurl CDATA #REQUIRED>
211.IP 212.IP
212<!ELEMENT include EMPTY> 213<!ELEMENT include EMPTY>
213<!ATTLIST include name CDATA #REQUIRED> 214<!ATTLIST include name CDATA #REQUIRED>
214<!ATTLIST include groups CDATA #IMPLIED> 215<!ATTLIST include groups CDATA #IMPLIED>
216<!ATTLIST include revision CDATA #IMPLIED>
215.PP 217.PP
216]> 218]>
217``` 219```
@@ -533,13 +535,24 @@ the repo client.
533.PP 535.PP
534Element remove\-project 536Element remove\-project
535.PP 537.PP
536Deletes the named project from the internal manifest table, possibly allowing a 538Deletes a project from the internal manifest table, possibly allowing a
537subsequent project element in the same manifest file to replace the project with 539subsequent project element in the same manifest file to replace the project with
538a different source. 540a different source.
539.PP 541.PP
540This element is mostly useful in a local manifest file, where the user can 542This element is mostly useful in a local manifest file, where the user can
541remove a project, and possibly replace it with their own definition. 543remove a project, and possibly replace it with their own definition.
542.PP 544.PP
545The project `name` or project `path` can be used to specify the remove target
546meaning one of them is required. If only name is specified, all projects with
547that name are removed.
548.PP
549If both name and path are specified, only projects with the same name and path
550are removed, meaning projects with the same name but in other locations are
551kept.
552.PP
553If only path is specified, a matching project is removed regardless of its name.
554Logic otherwise behaves like both are specified.
555.PP
543Attribute `optional`: Set to true to ignore remove\-project elements with no 556Attribute `optional`: Set to true to ignore remove\-project elements with no
544matching `project` element. 557matching `project` element.
545.PP 558.PP
@@ -608,7 +621,10 @@ included manifest belong. This appends and recurses, meaning all projects in
608included manifests carry all parent include groups. Same syntax as the 621included manifests carry all parent include groups. Same syntax as the
609corresponding element of `project`. 622corresponding element of `project`.
610.PP 623.PP
611Local Manifests 624Attribute `revision`: Name of a Git branch (e.g. `main` or `refs/heads/main`)
625default to which all projects in the included manifest belong.
626.PP
627Local Manifests
612.PP 628.PP
613Additional remotes and projects may be added through local manifest files stored 629Additional remotes and projects may be added through local manifest files stored
614in `$TOP_DIR/.repo/local_manifests/*.xml`. 630in `$TOP_DIR/.repo/local_manifests/*.xml`.
diff --git a/man/repo-smartsync.1 b/man/repo-smartsync.1
index c1abbb38..1e979102 100644
--- a/man/repo-smartsync.1
+++ b/man/repo-smartsync.1
@@ -1,5 +1,5 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man. 1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "November 2022" "repo smartsync" "Repo Manual" 2.TH REPO "1" "April 2024" "repo smartsync" "Repo Manual"
3.SH NAME 3.SH NAME
4repo \- repo smartsync - manual page for repo smartsync 4repo \- repo smartsync - manual page for repo smartsync
5.SH SYNOPSIS 5.SH SYNOPSIS
@@ -37,6 +37,11 @@ overwrite an existing git directory if it needs to
37point to a different object directory. WARNING: this 37point to a different object directory. WARNING: this
38may cause loss of data 38may cause loss of data
39.TP 39.TP
40\fB\-\-force\-checkout\fR
41force checkout even if it results in throwing away
42uncommitted modifications. WARNING: this may cause
43loss of data
44.TP
40\fB\-\-force\-remove\-dirty\fR 45\fB\-\-force\-remove\-dirty\fR
41force remove projects with uncommitted modifications 46force remove projects with uncommitted modifications
42if projects no longer exist in the manifest. WARNING: 47if projects no longer exist in the manifest. WARNING:
diff --git a/man/repo-sync.1 b/man/repo-sync.1
index f006c03d..0327942a 100644
--- a/man/repo-sync.1
+++ b/man/repo-sync.1
@@ -1,5 +1,5 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man. 1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "November 2022" "repo sync" "Repo Manual" 2.TH REPO "1" "April 2024" "repo sync" "Repo Manual"
3.SH NAME 3.SH NAME
4repo \- repo sync - manual page for repo sync 4repo \- repo sync - manual page for repo sync
5.SH SYNOPSIS 5.SH SYNOPSIS
@@ -37,6 +37,11 @@ overwrite an existing git directory if it needs to
37point to a different object directory. WARNING: this 37point to a different object directory. WARNING: this
38may cause loss of data 38may cause loss of data
39.TP 39.TP
40\fB\-\-force\-checkout\fR
41force checkout even if it results in throwing away
42uncommitted modifications. WARNING: this may cause
43loss of data
44.TP
40\fB\-\-force\-remove\-dirty\fR 45\fB\-\-force\-remove\-dirty\fR
41force remove projects with uncommitted modifications 46force remove projects with uncommitted modifications
42if projects no longer exist in the manifest. WARNING: 47if projects no longer exist in the manifest. WARNING:
@@ -185,6 +190,11 @@ The \fB\-\-force\-sync\fR option can be used to overwrite existing git directori
185they have previously been linked to a different object directory. WARNING: This 190they have previously been linked to a different object directory. WARNING: This
186may cause data to be lost since refs may be removed when overwriting. 191may cause data to be lost since refs may be removed when overwriting.
187.PP 192.PP
193The \fB\-\-force\-checkout\fR option can be used to force git to switch revs even if the
194index or the working tree differs from HEAD, and if there are untracked files.
195WARNING: This may cause data to be lost since uncommitted changes may be
196removed.
197.PP
188The \fB\-\-force\-remove\-dirty\fR option can be used to remove previously used projects 198The \fB\-\-force\-remove\-dirty\fR option can be used to remove previously used projects
189with uncommitted changes. WARNING: This may cause data to be lost since 199with uncommitted changes. WARNING: This may cause data to be lost since
190uncommitted changes may be removed with projects that no longer exist in the 200uncommitted changes may be removed with projects that no longer exist in the
diff --git a/man/repo-upload.1 b/man/repo-upload.1
index b8f6677c..bb11dfa3 100644
--- a/man/repo-upload.1
+++ b/man/repo-upload.1
@@ -1,5 +1,5 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man. 1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "August 2022" "repo upload" "Repo Manual" 2.TH REPO "1" "April 2024" "repo upload" "Repo Manual"
3.SH NAME 3.SH NAME
4repo \- repo upload - manual page for repo upload 4repo \- repo upload - manual page for repo upload
5.SH SYNOPSIS 5.SH SYNOPSIS
@@ -30,6 +30,9 @@ add local branch name as a hashtag
30\fB\-l\fR LABELS, \fB\-\-label\fR=\fI\,LABELS\/\fR 30\fB\-l\fR LABELS, \fB\-\-label\fR=\fI\,LABELS\/\fR
31add a label when uploading 31add a label when uploading
32.TP 32.TP
33\fB\-\-pd\fR=\fI\,PATCHSET_DESCRIPTION\/\fR, \fB\-\-patchset\-description\fR=\fI\,PATCHSET_DESCRIPTION\/\fR
34description for patchset
35.TP
33\fB\-\-re\fR=\fI\,REVIEWERS\/\fR, \fB\-\-reviewers\fR=\fI\,REVIEWERS\/\fR 36\fB\-\-re\fR=\fI\,REVIEWERS\/\fR, \fB\-\-reviewers\fR=\fI\,REVIEWERS\/\fR
34request reviews from these people 37request reviews from these people
35.TP 38.TP
@@ -198,6 +201,12 @@ review.URL.uploadnotify:
198Control e\-mail notifications when uploading. 201Control e\-mail notifications when uploading.
199https://gerrit\-review.googlesource.com/Documentation/user\-upload.html#notify 202https://gerrit\-review.googlesource.com/Documentation/user\-upload.html#notify
200.PP 203.PP
204review.URL.uploadwarningthreshold:
205.PP
206Repo will warn you if you are attempting to upload a large number of commits in
207one or more branches. By default, the threshold is five commits. This option
208allows you to override the warning threshold to a different value.
209.PP
201References 210References
202.PP 211.PP
203Gerrit Code Review: https://www.gerritcodereview.com/ 212Gerrit Code Review: https://www.gerritcodereview.com/
diff --git a/man/repo.1 b/man/repo.1
index 46425c69..bda68c39 100644
--- a/man/repo.1
+++ b/man/repo.1
@@ -1,5 +1,5 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man. 1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "June 2023" "repo" "Repo Manual" 2.TH REPO "1" "April 2024" "repo" "Repo Manual"
3.SH NAME 3.SH NAME
4repo \- repository management tool built on top of git 4repo \- repository management tool built on top of git
5.SH SYNOPSIS 5.SH SYNOPSIS
@@ -79,12 +79,6 @@ Download and checkout a change
79forall 79forall
80Run a shell command in each project 80Run a shell command in each project
81.TP 81.TP
82gitc\-delete
83Delete a GITC Client.
84.TP
85gitc\-init
86Initialize a GITC Client.
87.TP
88grep 82grep
89Print lines matching a pattern 83Print lines matching a pattern
90.TP 84.TP