blob: 76ee8c77aa2e54920ab71bee5e04d9f69062452c [file] [log] [blame]
Lloyd Pique016680d2017-11-29 17:54:29 -08001These instructions are for the Android external/wayland-protcools repository.
Rob Buis979e6a12017-10-02 17:39:48 +00002
Lloyd Pique016680d2017-11-29 17:54:29 -08003## Updating from upstream
Rob Buis979e6a12017-10-02 17:39:48 +00004
Lloyd Pique016680d2017-11-29 17:54:29 -08005### Update the freedesktop.org/ directory
6
7 1. Checkout the upstream sources to a working directory if you haven't
8 already with
9 `git clone git://anongit.freedesktop.org/wayland/wayland-protocols`,
10 or otherwise pull down the latest changes if you have a checkout.
11 2. Sync to the desired release tag (`git tag -l` to view them)
12 `git checkout $TAG`
13 3. The freedesktop.org/ directory here should be a simple copy of this
14 checkout. A tool such as `meld` can be used to view and apply the
15 differences.
16 `meld freedesktop.org/ /path/to/freedesktop.org/wayland-protocols/`
17 4. Note that we add NOTICE, MODULE_LICENSE_MIT and METADATA files as part of
18 our policies around open source code. Leave these alone unless there is
19 a reason to change them.
20 * NOTICE should duplicate COPYING from upstream.
21 * MODULE_LICENSE_MIT should match the source code license.
22 * METADATA should indicate the version of the upstream source used, and
23 should be updated to match.
24
25### Update the chromium.org/ directory
26
27 1. Checkout Chromium sources if you haven't already with
28 `git clone https://chromium.googlesource.com/chromium/src.git`, or
29 otherwise pull down the latest changes. This is a large checkout
30 unfortunately, even though we only want a small subset of it.
31 2. Sync to the desired release tag, or just use master if you would like.
32 3. The chromium.org/ directory should ba a **PARTIAL** copy of
33 src/third_party/wayland-protocols from your checkout. In particular these
34 should match:
35 * chromium.org/unstable/ and src/third_party/wayland-protocols/unstable/
36 * chromium.org/LICENSE and src/third_party/wayland-protocols/LICENSE
37 * chromium.org/README.chromium and src/third_party/wayland-protocols/README.chromium
38 We **do not** need:
39 * src/third_party/wayland-protocols/include/ and
40 src/third_party/wayland-protocols/protocol both contain source code
41 generated from the protocol files, which is not needed here.
42 * src/third_party/wayland-protocols/src (if you have it) is itself a clone
43 of a version of the freedesktop.org upstream sources.
44 * src/third_party/wayland-protocols/OWNERS causes trouble with Android
45 Gerrit.
46 * src/third_party/wayland-protocols/BUILD.gn.
47 4. Note that we add NOTICE, MODULE_LICENSE_MIT and METADATA files as part of
48 our policies around open source code. Leave these alone unless there is
49 a reason to change them.
50 * NOTICE should duplicate LICENSE from upstream.
51 * MODULE_LICENSE_MIT should match the source code license.
52 * METADATA should indicate the version of the upstream source used, and
53 should be updated to match.