diff options
Diffstat (limited to 'man/repo-manifest.1')
| -rw-r--r-- | man/repo-manifest.1 | 92 |
1 files changed, 88 insertions, 4 deletions
diff --git a/man/repo-manifest.1 b/man/repo-manifest.1 index ab9f7ed3..382918ce 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" "November 2021" "repo manifest" "Repo Manual" | 2 | .TH REPO "1" "July 2022" "repo manifest" "Repo Manual" |
| 3 | .SH NAME | 3 | .SH NAME |
| 4 | repo \- repo manifest - manual page for repo manifest | 4 | repo \- repo manifest - manual page for repo manifest |
| 5 | .SH SYNOPSIS | 5 | .SH SYNOPSIS |
| @@ -40,7 +40,8 @@ format output for humans to read | |||
| 40 | ignore local manifests | 40 | ignore local manifests |
| 41 | .TP | 41 | .TP |
| 42 | \fB\-o\fR \-|NAME.xml, \fB\-\-output\-file\fR=\fI\,\-\/\fR|NAME.xml | 42 | \fB\-o\fR \-|NAME.xml, \fB\-\-output\-file\fR=\fI\,\-\/\fR|NAME.xml |
| 43 | file to save the manifest to | 43 | file to save the manifest to. (Filename prefix for |
| 44 | multi\-tree.) | ||
| 44 | .SS Logging options: | 45 | .SS Logging options: |
| 45 | .TP | 46 | .TP |
| 46 | \fB\-v\fR, \fB\-\-verbose\fR | 47 | \fB\-v\fR, \fB\-\-verbose\fR |
| @@ -48,6 +49,19 @@ show all output | |||
| 48 | .TP | 49 | .TP |
| 49 | \fB\-q\fR, \fB\-\-quiet\fR | 50 | \fB\-q\fR, \fB\-\-quiet\fR |
| 50 | only show errors | 51 | only show errors |
| 52 | .SS Multi\-manifest options: | ||
| 53 | .TP | ||
| 54 | \fB\-\-outer\-manifest\fR | ||
| 55 | operate starting at the outermost manifest | ||
| 56 | .TP | ||
| 57 | \fB\-\-no\-outer\-manifest\fR | ||
| 58 | do not operate on outer manifests | ||
| 59 | .TP | ||
| 60 | \fB\-\-this\-manifest\-only\fR | ||
| 61 | only operate on this (sub)manifest | ||
| 62 | .TP | ||
| 63 | \fB\-\-no\-this\-manifest\-only\fR, \fB\-\-all\-manifests\fR | ||
| 64 | operate on this manifest and its submanifests | ||
| 51 | .PP | 65 | .PP |
| 52 | Run `repo help manifest` to view the detailed manual. | 66 | Run `repo help manifest` to view the detailed manual. |
| 53 | .SH DETAILS | 67 | .SH DETAILS |
| @@ -88,6 +102,7 @@ A manifest XML file (e.g. `default.xml`) roughly conforms to the following DTD: | |||
| 88 | remote*, | 102 | remote*, |
| 89 | default?, | 103 | default?, |
| 90 | manifest\-server?, | 104 | manifest\-server?, |
| 105 | submanifest*?, | ||
| 91 | remove\-project*, | 106 | remove\-project*, |
| 92 | project*, | 107 | project*, |
| 93 | extend\-project*, | 108 | extend\-project*, |
| @@ -118,6 +133,16 @@ include*)> | |||
| 118 | .IP | 133 | .IP |
| 119 | <!ELEMENT manifest\-server EMPTY> | 134 | <!ELEMENT manifest\-server EMPTY> |
| 120 | <!ATTLIST manifest\-server url CDATA #REQUIRED> | 135 | <!ATTLIST manifest\-server url CDATA #REQUIRED> |
| 136 | .IP | ||
| 137 | <!ELEMENT submanifest EMPTY> | ||
| 138 | <!ATTLIST submanifest name ID #REQUIRED> | ||
| 139 | <!ATTLIST submanifest remote IDREF #IMPLIED> | ||
| 140 | <!ATTLIST submanifest project CDATA #IMPLIED> | ||
| 141 | <!ATTLIST submanifest manifest\-name CDATA #IMPLIED> | ||
| 142 | <!ATTLIST submanifest revision CDATA #IMPLIED> | ||
| 143 | <!ATTLIST submanifest path CDATA #IMPLIED> | ||
| 144 | <!ATTLIST submanifest groups CDATA #IMPLIED> | ||
| 145 | <!ATTLIST submanifest default\-groups CDATA #IMPLIED> | ||
| 121 | .TP | 146 | .TP |
| 122 | <!ELEMENT project (annotation*, | 147 | <!ELEMENT project (annotation*, |
| 123 | project*, | 148 | project*, |
| @@ -295,6 +320,65 @@ GetManifest(tag) | |||
| 295 | Return a manifest in which each project is pegged to the revision at the | 320 | Return a manifest in which each project is pegged to the revision at the |
| 296 | specified tag. This is used by repo sync when the \fB\-\-smart\-tag\fR option is given. | 321 | specified tag. This is used by repo sync when the \fB\-\-smart\-tag\fR option is given. |
| 297 | .PP | 322 | .PP |
| 323 | Element submanifest | ||
| 324 | .PP | ||
| 325 | One or more submanifest elements may be specified. Each element describes a | ||
| 326 | single manifest to be checked out as a child. | ||
| 327 | .PP | ||
| 328 | Attribute `name`: A unique name (within the current (sub)manifest) for this | ||
| 329 | submanifest. It acts as a default for `revision` below. The same name can be | ||
| 330 | used for submanifests with different parent (sub)manifests. | ||
| 331 | .PP | ||
| 332 | Attribute `remote`: Name of a previously defined remote element. If not supplied | ||
| 333 | the remote given by the default element is used. | ||
| 334 | .PP | ||
| 335 | Attribute `project`: The manifest project name. The project's name is appended | ||
| 336 | onto its remote's fetch URL to generate the actual URL to configure the Git | ||
| 337 | remote with. The URL gets formed as: | ||
| 338 | .IP | ||
| 339 | ${remote_fetch}/${project_name}.git | ||
| 340 | .PP | ||
| 341 | where ${remote_fetch} is the remote's fetch attribute and ${project_name} is the | ||
| 342 | project's name attribute. The suffix ".git" is always appended as repo assumes | ||
| 343 | the upstream is a forest of bare Git repositories. If the project has a parent | ||
| 344 | element, its name will be prefixed by the parent's. | ||
| 345 | .PP | ||
| 346 | The project name must match the name Gerrit knows, if Gerrit is being used for | ||
| 347 | code reviews. | ||
| 348 | .PP | ||
| 349 | `project` must not be empty, and may not be an absolute path or use "." or ".." | ||
| 350 | path components. It is always interpreted relative to the remote's fetch | ||
| 351 | settings, so if a different base path is needed, declare a different remote with | ||
| 352 | the new settings needed. | ||
| 353 | .PP | ||
| 354 | If not supplied the remote and project for this manifest will be used: `remote` | ||
| 355 | cannot be supplied. | ||
| 356 | .PP | ||
| 357 | Projects from a submanifest and its submanifests are added to the | ||
| 358 | submanifest::path:<path_prefix> group. | ||
| 359 | .PP | ||
| 360 | Attribute `manifest\-name`: The manifest filename in the manifest project. If not | ||
| 361 | supplied, `default.xml` is used. | ||
| 362 | .PP | ||
| 363 | Attribute `revision`: Name of a Git branch (e.g. "main" or "refs/heads/main"), | ||
| 364 | tag (e.g. "refs/tags/stable"), or a commit hash. If not supplied, `name` is | ||
| 365 | used. | ||
| 366 | .PP | ||
| 367 | Attribute `path`: An optional path relative to the top directory of the repo | ||
| 368 | client where the submanifest repo client top directory should be placed. If not | ||
| 369 | supplied, `revision` is used. | ||
| 370 | .PP | ||
| 371 | `path` may not be an absolute path or use "." or ".." path components. | ||
| 372 | .PP | ||
| 373 | Attribute `groups`: List of additional groups to which all projects in the | ||
| 374 | included submanifest belong. This appends and recurses, meaning all projects in | ||
| 375 | submanifests carry all parent submanifest groups. Same syntax as the | ||
| 376 | corresponding element of `project`. | ||
| 377 | .PP | ||
| 378 | Attribute `default\-groups`: The list of manifest groups to sync if no | ||
| 379 | `\-\-groups=` parameter was specified at init. When that list is empty, use this | ||
| 380 | list instead of "default" as the list of groups to sync. | ||
| 381 | .PP | ||
| 298 | Element project | 382 | Element project |
| 299 | .PP | 383 | .PP |
| 300 | One or more project elements may be specified. Each element describes a single | 384 | One or more project elements may be specified. Each element describes a single |
| @@ -513,8 +597,8 @@ restrictions are not enforced for [Local Manifests]. | |||
| 513 | .PP | 597 | .PP |
| 514 | Attribute `groups`: List of additional groups to which all projects in the | 598 | Attribute `groups`: List of additional groups to which all projects in the |
| 515 | included manifest belong. This appends and recurses, meaning all projects in | 599 | included manifest belong. This appends and recurses, meaning all projects in |
| 516 | sub\-manifests carry all parent include groups. Same syntax as the corresponding | 600 | included manifests carry all parent include groups. Same syntax as the |
| 517 | element of `project`. | 601 | corresponding element of `project`. |
| 518 | .PP | 602 | .PP |
| 519 | Local Manifests | 603 | Local Manifests |
| 520 | .PP | 604 | .PP |
