android/git-repo
1
Fork 0
mirror of https://gerrit.googlesource.com/git-repo synced 2024-12-21 07:16:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

manifest-format: convert to markdown

Browse Source 
The gitiles system doesn't render .txt files, so convert this to .md
for better display online.

Change-Id: Ie12e46daf008dd8c97ae2ffd21fb68bd948fe625
This commit is contained in:
Mike Frysinger 2018-10-05 19:26:15 -04:00
parent 2b42d288c0
commit 3891b7519d
4 changed files with 92 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -11,6 +11,6 @@ that you can put anywhere in your path.
* Source: https://code.google.com/p/git-repo/ * Source: https://code.google.com/p/git-repo/
* Overview: https://source.android.com/source/developing.html * Overview: https://source.android.com/source/developing.html
* Docs: https://source.android.com/source/using-repo.html * Docs: https://source.android.com/source/using-repo.html
* [repo Manifest Format](./docs/manifest-format.txt) * [repo Manifest Format](./docs/manifest-format.md)
* [repo Hooks](./docs/repo-hooks.md) * [repo Hooks](./docs/repo-hooks.md)
* [Submitting patches](./SUBMITTING_PATCHES.md) * [Submitting patches](./SUBMITTING_PATCHES.md)

14
docs/manifest-format.txt → docs/manifest-format.md
View File

@ -6,20 +6,23 @@ the directories that are visible and where they should be obtained
from with git. from with git.
The basic structure of a manifest is a bare Git repository holding The basic structure of a manifest is a bare Git repository holding
a single 'default.xml' XML file in the top level directory. a single `default.xml` XML file in the top level directory.
Manifests are inherently version controlled, since they are kept Manifests are inherently version controlled, since they are kept
within a Git repository. Updates to manifests are automatically within a Git repository. Updates to manifests are automatically
obtained by clients during `repo sync`. obtained by clients during `repo sync`.
[TOC]
XML File Format XML File Format
--------------- ---------------
A manifest XML file (e.g. 'default.xml') roughly conforms to the A manifest XML file (e.g. `default.xml`) roughly conforms to the
following DTD: following DTD:
<!DOCTYPE manifest [ ```xml
<!DOCTYPE manifest [
<!ELEMENT manifest (notice?, <!ELEMENT manifest (notice?,
remote*, remote*,
default?, default?,
@ -98,7 +101,8 @@ following DTD:
<!ELEMENT include EMPTY> <!ELEMENT include EMPTY>
<!ATTLIST include name CDATA #REQUIRED> <!ATTLIST include name CDATA #REQUIRED>
]> ]>
```
A description of the elements and their attributes follows. A description of the elements and their attributes follows.
@ -326,7 +330,7 @@ Element copyfile
Zero or more copyfile elements may be specified as children of a Zero or more copyfile elements may be specified as children of a
project element. Each element describes a src-dest pair of files; project element. Each element describes a src-dest pair of files;
the "src" file will be copied to the "dest" place during 'repo sync' the "src" file will be copied to the "dest" place during `repo sync`
command. command.
"src" is project relative, "dest" is relative to the top of the tree. "src" is project relative, "dest" is relative to the top of the tree.

2
docs/repo-hooks.md
View File

@ -24,7 +24,7 @@ repohooks project is updated and a hook is triggered.
## Manifest Settings ## Manifest Settings
For the full syntax, see the [repo manifest format](./manifest-format.txt). For the full syntax, see the [repo manifest format](./manifest-format.md).
Here's a short example from Here's a short example from
[Android](https://android.googlesource.com/platform/manifest/+/master/default.xml). [Android](https://android.googlesource.com/platform/manifest/+/master/default.xml).

2
subcmds/manifest.py
View File

@ -39,7 +39,7 @@ in a Git repository for use during future 'repo init' invocations.
helptext = self._helpDescription + '\n' helptext = self._helpDescription + '\n'
r = os.path.dirname(__file__) r = os.path.dirname(__file__)
r = os.path.dirname(r) r = os.path.dirname(r)
fd = open(os.path.join(r, 'docs', 'manifest-format.txt')) fd = open(os.path.join(r, 'docs', 'manifest-format.md'))
for line in fd: for line in fd:
helptext += line helptext += line
fd.close() fd.close()