tizen-4.0-unified_20181001.2
[scm/manifest.git] / README
1 =================================
2 Manifest files for Tizen packages
3 =================================
4
5 Branches
6 --------
7
8 Different branches of manifest git are mapped to different version of Tizen:
9
10 =========   ================
11 Branches    Version of Tizen
12 =========   ================
13 tizen_2.1   2.1
14 tizen_2.1   2.2
15 tizen       3.0
16 =========   ================
17
18 Main manifest files for different branches(Versions)
19 ----------------------------------------------------
20
21 Tizen 2.1 and Tizen 2.2
22 '''''''''''''''''''''''
23
24 Tizen 2.1 and Tizen 2.2 have the same manifest structure:
25
26 - _metadata.xml:
27
28   meta packages including image-configuation, package-groups, build-config and gbs-config
29
30 - _prebuilt-{i586, arm}.xml:
31
32   pre-built binary toolchain related packages, which are used for local full buuild
33
34 - _projects.xml:
35
36   different groups of packages
37
38 There's only no profile special manifest file in Tizen 2.1 and Tizen 2.2,
39 only common (default.xml) exists.
40
41 Tizen 3.0
42 '''''''''
43
44 IVI, Mobile and Common profiles are supportted in Tizen 3.0.
45
46 ivi.xml: main index file for ivi profile
47 mobile.xml: main index file for mobile profile
48 common.xml: main index file for common profile
49
50 Different profiles have its' different package list and pre-builts, as there's no
51 common packages are shared, so packages list must be maintained individually.
52
53 Basic Usage::
54     $  repo init -u <url> -b tizen -m ivi.xml
55     $  repo init -u <url> -b tizen -m mobile.xml
56
57 Update manifests for Tizen 3.0
58 '''''''''''''''''''''''''''''
59
60 The manifest maintained in scm/manifest project is the combination about all
61 manfiests of each profile(common/mobile).
62
63 The script check_manifest.py is working for updating manifest, after 'repo init'
64 above.
65 The script will download the latest manifests from latest snapshot repo,
66 then make a diff between the local manifests(from review.tizen.org) and latest
67 ones.
68 If there are any updates, check them by git-diff under .repo/manfiest dir and
69 submit to remote if needed.
70
71 Basic Usage::
72     $ check_manifest.py --tizen-src . -p <profile> --url <profile-latest> --update
73
74 Example::
75     $ check_manifest.py --tizen-src . -p mobile --url mobile-latest --update
76
77 Notes
78 '''''
79
80 During update, the script will get all branches of updated packages from
81 review.tizen.org, so the usrname and passwd for loggging in are needed to fill
82 first:
83
84 ::
85
86   171 gc = GerritClient('https://review.tizen.org/gerrit', '<usrname>', '<passwd>')