Weston

Weston — это композитор для Wayland, спроектированный с учётом корректности, надёжности, предсказуемости и производительности.

По умолчанию Weston предоставляет очень базовый рабочий стол или полноэкранное окружение для нерабочих целей, таких как автомобили, встраиваемые системы, авиаперевозки, промышленность, киоски, устройства для просмотра видео и телевизоры.

Он также предлагает библиотеку под названием libweston, которая позволяет пользователям создавать свои собственные специализированные окружения на основе основного ядра Weston.

Компиляция Weston

Weston собирается с помощью Meson. Weston часто зависит от текущих выпусков Wayland и wayland-protocols.

Если требуется, последнюю версию Meson можно установить как пользователь следующими командами:

$ pip3 install --user meson

Meson сборки Weston не выполняет автоматическое распознавание и по умолчанию все возможности включены, что может привести к недостающим зависимостям при первой попытке сборки. Если зависимость можно избежать через опцию сборки, сообщение об ошибке должно указывать, какую опцию следует использовать для этого. Возможно, вам придётся отключить несколько возможностей, чтобы избежать некоторых зависимостей. $ git clone https://gitlab.freedesktop.org/wayland/weston.git $ cd weston $ meson build/ --prefix=... $ ninja -C build/ install $ cd ..

Команда meson заполняет каталог сборки. Этот шаг может завершиться ошибкой из-за отсутствующих зависимостей. Любые опции сборки, которые вы хотите использовать, могут быть добавлены на этой строке, например meson build/ --prefix=... -Ddemo-clients=false. Все опции сборки можно найти в файле meson_options.txt.

После успешного заполнения каталога сборки, вы можете проверить конфигурацию с помощью meson configure build/. Если вам нужно изменить опцию, вы можете сделать это, например, meson configure build/ -Ddemo-clients=false.

Каждый пуш к репозиторию Weston master и его форкам строится с использованием GitLab CI. Чтение конфигурации может предоставить полезный пример того, как собирать и устанавливать Weston.

Более детальная документация по сборке Weston доступна на сайте Wayland. Также есть более подробная информация о том, как запустить и написать тесты. Для сборки документации см. документацию.

Запуск Weston

После установки Weston большинство пользователей могут запустить его, введя команду weston. Это запустит Weston внутри того окружения, из которого он был запущен: если запустить его с текстового консоли, он займет эту консоль. Если запустить его внутри существующего сессии Wayland или X11, он начнет "внедренную" версию Weston внутри окна этой сессии.По умолчанию Weston запускается с простым рабочим столом, который называется desktop-shell. Также доступны другие шеллы; например, чтобы загрузить шелл kiosk, предназначенный для одностраничных приложений, используйте следующую команду:

$ weston --shell=kiosk

Помощь доступна через выполнение команды weston --help или man weston, которая выводит список доступных вариантов конфигурации и отображаемых бэкендов. Конфигурацию также можно задать через файл на диске; более подробная информация об этом содержится в man weston.ini.

Также предоставляются небольшие примеры клиентских или демонстрационных приложений: хотя они могут быть полезны самостоятельно, основная цель этих примеров — служить образцами или тестовыми случаями для других, создающих композиторы или клиенты.

Использование libweston

libweston предназначен для использования теми, кто хочет использовать основные функции Weston — его поддержку клиентов, бэкендов и рендеринг — при реализации своего собственного пользовательского интерфейса, политик, конфигураций и жизненного цикла. Если вам требуется создать свой собственный менеджер окон или среду рабочего стола, мы рекомендуем использовать API libweston для вашего проекта.Сборка и установка Weston также устанавливают общедоступную библиотеку libweston и заголовочные файлы для разработки. Библиотека libweston совместима как по API, так и по ABI внутри одного стабильного выпуска. Она параллельно устанавливаема, поэтому несколько стабильных выпусков могут быть установлены и использованы одновременно.Документация для API libweston находится в источниках (см. раздел документация), а также доступна на онлайн-документации Weston для текущего стабильного выпуска.

Отчет о проблемах и участие

Разработка Weston осуществляется на платформе freedesktop.org GitLab. Подробная информация о том, как сделать вклад в код или нетехнические изменения в Weston, представлена в документе участия. Weston и libweston не подходят для сред с очень ограниченной памятью, где композитор должен продолжать работу даже при неудачном выделении памяти. Если стандартные функции, такие как malloc(), не могут выполнить выделение памяти для небольших аллоцирований, можно ожидать, что libweston завершится аварийно. Это вероятно произойдет только если вы отключили функциональность "перезаполнения" вашей ОС, а не в обычных случаях.

Документация

Чтобы прочитать онлайн-документацию Weston, перейдите на сайт Weston.

Для документирования Weston мы используем Sphinx в сочетании с Breathe для обработки и улучшения документации кода из Doxygen. Вы должны иметь возможность установить как Sphinx, так и расширение Breathe с помощью команды pip3 или вашего менеджера пакетов. Doxygen также доступен через ваш менеджер пакетов системы.После установки этих инструментов запустите meson с опцией -Ddoc=true, чтобы активировать построение документации. Установка поместит документацию в каталог datadir префикса (например, share/doc).

Добавление и улучшение документации

Для повторного генерирования документации был добавлен специальный целевой объект docs. Хотя при первом сборке (и последующей установке) Weston вы заметите, что документация строится, обновления sponge-документов или исходных файлов будут обновлены только при использовании целевого объекта docs!

Пример:

$ ninja install # создаёт и устанавливает документацию
# время проходит, работа над проектом, добавление документации в исходники или rST файлах
$ ninja install # недостаточно, документация не будет обновлена
$ ninja docs && ninja install # запустите 'docs', затем установите

Улучшение/добавление документации можно сделать путём изменения rST файлов в директории doc/sphinx/ или изменением исходного кода с использованием директив Doxygen.