Jiri Simsa | 41fb378 | 2015-02-18 11:24:46 -0800 | [diff] [blame] | 1 | # Manifests |
Jiri Simsa | 39a40a6 | 2014-10-11 09:08:05 -0700 | [diff] [blame] | 2 | |
Jenkins Veyron | 0e2b7c9 | 2014-11-20 20:28:15 -0800 | [diff] [blame] | 3 | The files in this repository are referred to as "manifests" and |
Jiri Simsa | 41fb378 | 2015-02-18 11:24:46 -0800 | [diff] [blame] | 4 | are used by the v23 tool for multi-repository management. Each |
Jiri Simsa | e7bf98b | 2014-10-20 16:04:32 -0700 | [diff] [blame] | 5 | manifest describes a set of projects and each project consist of a |
| 6 | remote repository, a local path, and other optional attributes. |
| 7 | |
| 8 | Backwards incompatible changes to the manifest format are deployed by |
Jenkins Veyron | 0e2b7c9 | 2014-11-20 20:28:15 -0800 | [diff] [blame] | 9 | creating a new 'version' subdirectory (e.g. v2) and a new default |
| 10 | manifest (e.g. v2/default), which is used by new versions of the |
| 11 | veyron tool by default. Format of existing manifest files should not |
| 12 | be changed as old versions of the veyron tool would not be able to |
| 13 | parse them. |
Jiri Simsa | 41fb378 | 2015-02-18 11:24:46 -0800 | [diff] [blame] | 14 | |
| 15 | To add a project to an existing Vanadium universe, one should add |
| 16 | it to relevant manifest for all versions that are still supported, |
| 17 | following the format of the respective versions. |
| 18 | |
| 19 | Further, the set of projects that form a Vanadium universe should be |
| 20 | closed under transitive closure with respect to dependencies. In other |
| 21 | words, if a project A depends on a project B, then project A should |
| 22 | only be included in manifests that include project B as well. |