third_party/weston/README.chromium

   1 Name: Weston - reference Wayland compositor
   2 Short Name: Weston
   3 URL: https://gitlab.freedesktop.org/wayland/weston
   4 Version: 12.0.1
   5 License: MIT
   6 License File: LICENSE
   7 Security Critical: no
   8 Shipped: no
   9 Source: https://gitlab.freedesktop.org/wayland/weston
  10
  11 --[ DESCRIPTION ] ------------------
  12 This contains the source to the reference Wayland compositor called Weston.
  13 The LICENSE file is copied from src/COPYING
  14 This code is only for running tests of Chromium for Wayland and is not compiled
  15 into Chrome
  16
  17 --[ UPDATING ] -----------------
  18 Chromium infrastructure has a mirror of the Weston's official gitlab
  19 repository, but the mirror is set up in such a way that it is possible to
  20 maintain branches of Weston with additional patches applied (which
  21 should be submitted into upstream).
  22
  23 Thus, before updating DEPS, one has to request one of the maintainers of
  24 //third_party/weston to create a branch out of a new remote branch
  25 (for example, if the remote has a new tag 10.0.0 that is created out of
  26 10.0 branch, a new 10.0 branch needs to be created) and ask to rebase
  27 patches for that new branch. Once the changes are pushed, change the commit
  28 hash with the hash pointing to the submitted patches inside the DEPS file.
  29 You need to have clang (//third_party/llvm-build/Release+Asserts/bin),
  30 and meson (https://github.com/mesonbuild/meson/releases) in your path.
  31 Then do gclient sync which will align your local Weston folder with the most
  32 recent one as mentioned in the hash. Then run the generate_configs.py script
  33 to generate and update necessary config files. To compile weston, pass the
  34 following GN arguments while generating build files, since gn gen is meant
  35 to generate ninja files not gn ones.
  36 use_ozone = true use_bundled_weston = true
  37
  38 Finally, compile-test the Weston target.
  39 Steps to be followed:
  40 gclient sync
  41 python3 third_party/weston/generate_configs.py
  42 autoninja out/build_dir weston
  43
  44 To update the weston to the version present upstream, change the commit hash
  45 inside url in the 'src/third_party/weston/src' field with the most recent one in
  46 DEPS file. Then follow the above steps to compile the updated weston.