diff options
| author | Mike Frysinger <vapier@google.com> | 2018-10-10 01:05:11 -0400 |
|---|---|---|
| committer | Mike Frysinger <vapier@google.com> | 2018-10-10 01:28:43 -0400 |
| commit | b8f7bb04d003f8dbcf3ef2b201fc2678308995af (patch) | |
| tree | db5a3854124122b007821a0eec28d02b09ccb999 /docs | |
| parent | 3891b7519d35b6bac3e81744c846ca2ed0bd1be2 (diff) | |
| download | git-repo-b8f7bb04d003f8dbcf3ef2b201fc2678308995af.tar.gz | |
update markdown/help header format
Since gitiles recommends using # headers over ---/=== underlines,
change the manifest-format.md over and all our help texts.
Change-Id: I96391d41fba769e9f26870d497cf7cf01c8d8ab3
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manifest-format.md | 42 |
1 files changed, 14 insertions, 28 deletions
diff --git a/docs/manifest-format.md b/docs/manifest-format.md index cf48698d..c85726bc 100644 --- a/docs/manifest-format.md +++ b/docs/manifest-format.md | |||
| @@ -1,5 +1,4 @@ | |||
| 1 | repo Manifest Format | 1 | # repo Manifest Format |
| 2 | ==================== | ||
| 3 | 2 | ||
| 4 | A repo manifest describes the structure of a repo client; that is | 3 | A repo manifest describes the structure of a repo client; that is |
| 5 | the directories that are visible and where they should be obtained | 4 | the directories that are visible and where they should be obtained |
| @@ -15,8 +14,7 @@ obtained by clients during `repo sync`. | |||
| 15 | [TOC] | 14 | [TOC] |
| 16 | 15 | ||
| 17 | 16 | ||
| 18 | XML File Format | 17 | ## XML File Format |
| 19 | --------------- | ||
| 20 | 18 | ||
| 21 | A manifest XML file (e.g. `default.xml`) roughly conforms to the | 19 | A manifest XML file (e.g. `default.xml`) roughly conforms to the |
| 22 | following DTD: | 20 | following DTD: |
| @@ -107,14 +105,12 @@ following DTD: | |||
| 107 | A description of the elements and their attributes follows. | 105 | A description of the elements and their attributes follows. |
| 108 | 106 | ||
| 109 | 107 | ||
| 110 | Element manifest | 108 | ### Element manifest |
| 111 | ---------------- | ||
| 112 | 109 | ||
| 113 | The root element of the file. | 110 | The root element of the file. |
| 114 | 111 | ||
| 115 | 112 | ||
| 116 | Element remote | 113 | ### Element remote |
| 117 | -------------- | ||
| 118 | 114 | ||
| 119 | One or more remote elements may be specified. Each remote element | 115 | One or more remote elements may be specified. Each remote element |
| 120 | specifies a Git URL shared by one or more projects and (optionally) | 116 | specifies a Git URL shared by one or more projects and (optionally) |
| @@ -149,8 +145,7 @@ Attribute `revision`: Name of a Git branch (e.g. `master` or | |||
| 149 | `refs/heads/master`). Remotes with their own revision will override | 145 | `refs/heads/master`). Remotes with their own revision will override |
| 150 | the default revision. | 146 | the default revision. |
| 151 | 147 | ||
| 152 | Element default | 148 | ### Element default |
| 153 | --------------- | ||
| 154 | 149 | ||
| 155 | At most one default element may be specified. Its remote and | 150 | At most one default element may be specified. Its remote and |
| 156 | revision attributes are used when a project element does not | 151 | revision attributes are used when a project element does not |
| @@ -188,8 +183,7 @@ branch (specified in the `revision` attribute) rather than | |||
| 188 | the other ref tags. | 183 | the other ref tags. |
| 189 | 184 | ||
| 190 | 185 | ||
| 191 | Element manifest-server | 186 | ### Element manifest-server |
| 192 | ----------------------- | ||
| 193 | 187 | ||
| 194 | At most one manifest-server may be specified. The url attribute | 188 | At most one manifest-server may be specified. The url attribute |
| 195 | is used to specify the URL of a manifest server, which is an | 189 | is used to specify the URL of a manifest server, which is an |
| @@ -217,8 +211,7 @@ the specified tag. This is used by repo sync when the --smart-tag option | |||
| 217 | is given. | 211 | is given. |
| 218 | 212 | ||
| 219 | 213 | ||
| 220 | Element project | 214 | ### Element project |
| 221 | --------------- | ||
| 222 | 215 | ||
| 223 | One or more project elements may be specified. Each element | 216 | One or more project elements may be specified. Each element |
| 224 | describes a single Git repository to be cloned into the repo | 217 | describes a single Git repository to be cloned into the repo |
| @@ -295,8 +288,7 @@ rather than the `name` attribute. This attribute only applies to the | |||
| 295 | local mirrors syncing, it will be ignored when syncing the projects in a | 288 | local mirrors syncing, it will be ignored when syncing the projects in a |
| 296 | client working directory. | 289 | client working directory. |
| 297 | 290 | ||
| 298 | Element extend-project | 291 | ### Element extend-project |
| 299 | ---------------------- | ||
| 300 | 292 | ||
| 301 | Modify the attributes of the named project. | 293 | Modify the attributes of the named project. |
| 302 | 294 | ||
| @@ -314,8 +306,7 @@ belongs. Same syntax as the corresponding element of `project`. | |||
| 314 | Attribute `revision`: If specified, overrides the revision of the original | 306 | Attribute `revision`: If specified, overrides the revision of the original |
| 315 | project. Same syntax as the corresponding element of `project`. | 307 | project. Same syntax as the corresponding element of `project`. |
| 316 | 308 | ||
| 317 | Element annotation | 309 | ### Element annotation |
| 318 | ------------------ | ||
| 319 | 310 | ||
| 320 | Zero or more annotation elements may be specified as children of a | 311 | Zero or more annotation elements may be specified as children of a |
| 321 | project element. Each element describes a name-value pair that will be | 312 | project element. Each element describes a name-value pair that will be |
| @@ -325,8 +316,7 @@ prefixed with REPO__. In addition, there is an optional attribute | |||
| 325 | "false". This attribute determines whether or not the annotation will | 316 | "false". This attribute determines whether or not the annotation will |
| 326 | be kept when exported with the manifest subcommand. | 317 | be kept when exported with the manifest subcommand. |
| 327 | 318 | ||
| 328 | Element copyfile | 319 | ### Element copyfile |
| 329 | ---------------- | ||
| 330 | 320 | ||
| 331 | Zero or more copyfile elements may be specified as children of a | 321 | Zero or more copyfile elements may be specified as children of a |
| 332 | project element. Each element describes a src-dest pair of files; | 322 | project element. Each element describes a src-dest pair of files; |
| @@ -334,14 +324,12 @@ the "src" file will be copied to the "dest" place during `repo sync` | |||
| 334 | command. | 324 | command. |
| 335 | "src" is project relative, "dest" is relative to the top of the tree. | 325 | "src" is project relative, "dest" is relative to the top of the tree. |
| 336 | 326 | ||
| 337 | Element linkfile | 327 | ### Element linkfile |
| 338 | ---------------- | ||
| 339 | 328 | ||
| 340 | It's just like copyfile and runs at the same time as copyfile but | 329 | It's just like copyfile and runs at the same time as copyfile but |
| 341 | instead of copying it creates a symlink. | 330 | instead of copying it creates a symlink. |
| 342 | 331 | ||
| 343 | Element remove-project | 332 | ### Element remove-project |
| 344 | ---------------------- | ||
| 345 | 333 | ||
| 346 | Deletes the named project from the internal manifest table, possibly | 334 | Deletes the named project from the internal manifest table, possibly |
| 347 | allowing a subsequent project element in the same manifest file to | 335 | allowing a subsequent project element in the same manifest file to |
| @@ -351,8 +339,7 @@ This element is mostly useful in a local manifest file, where | |||
| 351 | the user can remove a project, and possibly replace it with their | 339 | the user can remove a project, and possibly replace it with their |
| 352 | own definition. | 340 | own definition. |
| 353 | 341 | ||
| 354 | Element include | 342 | ### Element include |
| 355 | --------------- | ||
| 356 | 343 | ||
| 357 | This element provides the capability of including another manifest | 344 | This element provides the capability of including another manifest |
| 358 | file into the originating manifest. Normal rules apply for the | 345 | file into the originating manifest. Normal rules apply for the |
| @@ -362,8 +349,7 @@ Attribute `name`: the manifest to include, specified relative to | |||
| 362 | the manifest repository's root. | 349 | the manifest repository's root. |
| 363 | 350 | ||
| 364 | 351 | ||
| 365 | Local Manifests | 352 | ## Local Manifests |
| 366 | =============== | ||
| 367 | 353 | ||
| 368 | Additional remotes and projects may be added through local manifest | 354 | Additional remotes and projects may be added through local manifest |
| 369 | files stored in `$TOP_DIR/.repo/local_manifests/*.xml`. | 355 | files stored in `$TOP_DIR/.repo/local_manifests/*.xml`. |
