diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manifest_submodule.txt | 130 | ||||
| -rw-r--r-- | docs/manifest_xml.txt (renamed from docs/manifest-format.txt) | 0 |
2 files changed, 130 insertions, 0 deletions
diff --git a/docs/manifest_submodule.txt b/docs/manifest_submodule.txt new file mode 100644 index 00000000..e7d1f643 --- /dev/null +++ b/docs/manifest_submodule.txt | |||
| @@ -0,0 +1,130 @@ | |||
| 1 | repo Manifest Format (submodule) | ||
| 2 | ================================ | ||
| 3 | |||
| 4 | A repo manifest describes the structure of a repo client; that is | ||
| 5 | the directories that are visible and where they should be obtained | ||
| 6 | from with git. | ||
| 7 | |||
| 8 | The basic structure of a manifest is a bare Git repository holding | ||
| 9 | a 'gitmodules' file in the top level directory, and one or more | ||
| 10 | gitlink references pointing at commits from the referenced projects. | ||
| 11 | This is the same structure as used by 'git submodule'. | ||
| 12 | |||
| 13 | Manifests are inherently version controlled, since they are kept | ||
| 14 | within a Git repository. Updates to manifests are automatically | ||
| 15 | obtained by clients during `repo sync`. | ||
| 16 | |||
| 17 | .gitmodules | ||
| 18 | =========== | ||
| 19 | |||
| 20 | The '.gitmodules' file, located in the top-level directory of the | ||
| 21 | client's working tree (or manifest repository), is a text file with | ||
| 22 | a syntax matching the requirements of 'git config'. | ||
| 23 | |||
| 24 | This file contains one subsection per project (also called a | ||
| 25 | submodule by git), and the subsection value is a unique name to | ||
| 26 | describe the project. Each submodule section must contain the | ||
| 27 | following required keys: | ||
| 28 | |||
| 29 | * path | ||
| 30 | * url | ||
| 31 | |||
| 32 | submodule.<name>.path | ||
| 33 | --------------------- | ||
| 34 | |||
| 35 | Defines the path, relative to the top-level directory of the client's | ||
| 36 | working tree, where the project is expected to be checked out. The | ||
| 37 | path name must not end with a '/'. All paths must be unique within | ||
| 38 | the .gitmodules file. | ||
| 39 | |||
| 40 | At the specified path within the manifest repository a gitlink | ||
| 41 | tree entry (an entry with file mode 160000) must exist referencing | ||
| 42 | a commit SHA-1 from the project. This tree entry specifies the | ||
| 43 | exact version of the project that `repo sync` will synchronize the | ||
| 44 | client's working tree to. | ||
| 45 | |||
| 46 | submodule.<name>.url | ||
| 47 | -------------------- | ||
| 48 | |||
| 49 | Defines a URL from where the project repository can be cloned. | ||
| 50 | By default `repo sync` will clone from this URL whenever a user | ||
| 51 | needs to access this project. | ||
| 52 | |||
| 53 | submodule.<name>.revision | ||
| 54 | ------------------------- | ||
| 55 | |||
| 56 | Name of the branch in the project repository that Gerrit Code Review | ||
| 57 | should automatically refresh the project's gitlink entry from. | ||
| 58 | |||
| 59 | If set, during submit of a change within the referenced project, | ||
| 60 | Gerrit Code Review will automatically update the manifest | ||
| 61 | repository's corresponding gitlink to the new commit SHA-1 of | ||
| 62 | this branch. | ||
| 63 | |||
| 64 | Valid values are a short branch name (e.g. 'master'), a full ref | ||
| 65 | name (e.g. 'refs/heads/master'), or '.' to request using the same | ||
| 66 | branch name as the manifest branch itself. Since '.' automatically | ||
| 67 | uses the manifest branch, '.' is the recommended value. | ||
| 68 | |||
| 69 | If this key is not set, Gerrit Code Review will NOT automatically | ||
| 70 | update the gitlink. An unset key requires the manifest maintainer | ||
| 71 | to manually update the gitlink when it is necessary to reference | ||
| 72 | a different revision of the project. | ||
| 73 | |||
| 74 | submodule.<name>.update | ||
| 75 | ----------------------- | ||
| 76 | |||
| 77 | This key is not supported by repo. If set, it will be ignored. | ||
| 78 | |||
| 79 | .review | ||
| 80 | ======= | ||
| 81 | |||
| 82 | The optional '.review' file, located in the top-level directory of | ||
| 83 | the client's working tree (or manifest repository), is a text file | ||
| 84 | with a syntax matching the requirements of 'git config'. | ||
| 85 | |||
| 86 | This file describes how `repo upload` should interact with the | ||
| 87 | project's preferred code review system. | ||
| 88 | |||
| 89 | review.url | ||
| 90 | ---------- | ||
| 91 | |||
| 92 | URL of the default Gerrit Code Review server. If a project does | ||
| 93 | not have a specific URL in the '.review' file, this default URL | ||
| 94 | will be used instead. | ||
| 95 | |||
| 96 | review.<name>.url | ||
| 97 | ----------------- | ||
| 98 | |||
| 99 | Project specific URL of the Gerrit Code Review server, for the | ||
| 100 | submodule whose project name is <name>. | ||
| 101 | |||
| 102 | Example | ||
| 103 | ======= | ||
| 104 | |||
| 105 | $ cat .gitmodules | ||
| 106 | [submodule "app/Clock"] | ||
| 107 | path = clock | ||
| 108 | url = git://vcs.example.com/ClockWidget.git | ||
| 109 | revision = . | ||
| 110 | [submodule "app/Browser"] | ||
| 111 | path = net/browser | ||
| 112 | url = git://netgroup.example.com/network/web/Browser.git | ||
| 113 | revision = . | ||
| 114 | |||
| 115 | $ cat .review | ||
| 116 | [review] | ||
| 117 | url = vcs-gerrit.example.com | ||
| 118 | [review "app/Browser"] | ||
| 119 | url = netgroup.example.com | ||
| 120 | |||
| 121 | In the above example, the app/Clock project will send its code | ||
| 122 | reviews to the default server, vcs-gerrit.example.com, while | ||
| 123 | app/Browser will send its code reviews to netgroup.example.com. | ||
| 124 | |||
| 125 | See Also | ||
| 126 | ======== | ||
| 127 | |||
| 128 | * http://www.kernel.org/pub/software/scm/git/docs/gitmodules.html | ||
| 129 | * http://www.kernel.org/pub/software/scm/git/docs/git-config.html | ||
| 130 | * http://code.google.com/p/gerrit/ | ||
diff --git a/docs/manifest-format.txt b/docs/manifest_xml.txt index da0e69ff..da0e69ff 100644 --- a/docs/manifest-format.txt +++ b/docs/manifest_xml.txt | |||
