Update README.txt
[scm/meta/git.git] / README.txt
1 Format of the files with metadata
2 =================================
3
4
5 General formatting rules
6 ------------------------
7
8 - Each file consists of one or more sections
9 - Each section separated by one or more empty lines
10 - Each line in section starts with capital letter (key),colon and space(s)
11 - Lines without key element are ignored
12
13
14 Git tree project object
15 -----------------------
16
17 Filename: "git-trees"
18     G: [mandatory] Git path - Read only
19     D: [mandatory] Domain
20     O: [optional] Owner(s)
21     B: [optional] Branch(es) - Read Only
22     L: [optional] License(s)
23     C: [optional] Comments
24
25
26 Domain object
27 -------------
28
29 Filename: "domains"
30     D: [mandatory] Domain - Read Only
31     N: [optional] reserved for parent domain (in case of declaring sub-domains) - Read Only
32     A: [optional] Architect(s)
33     M: [optional] Maintainer(s)
34     I: [optional] Integrator(s)
35     R: [optional] Reviewers(s)
36     E: [optional] Description - Read Only
37
38
39 Branch object
40 --------------
41
42 Filename: "branches"
43     B: [mandatory] Branch
44     P: [optional] Profile (Mobile,IVI,...)
45     E: [optional] Description
46
47
48 Reference
49 ---------
50
51 Field keys:
52     A - Architect. Format: FullName <address@domain>
53     B - Branch. Format: [a-z0-9\._]+
54     C - Comments.
55     D - Domain.
56     E - DEscription.
57     F - ?
58     G - Git path.
59     H - Homepage URL.
60     I - Integrator. Format: FullName <address@domain>
61     J - ?
62     K - ? 
63     L - Licenses.
64     M - Maintainer. Format: FullName <address@domain>
65     N - PareNt. References another domain object.
66     O - Git Owner. Format: FullName <address@domain>
67     P - Profile.
68     Q - ?
69     R - Reviewers.
70     S - Status.
71     T - ?
72     U - Upstream.
73     V - Upstream VCS.
74     W - ?
75     X - ?
76     Y - ?
77     Z - ?
78
79
80
81