Таблиця параметрів налаштування

Нижче наведено таблиці параметрів програми, у яких ви знайдете такі дані:

  • Назву параметра

  • Область дії параметра: global, module або module-set. Параметри в області дії module або/і module-set також можна визначати у розділах options.

  • Коментарі щодо призначення та способів використання параметра.

Таблиця 4.1. Параметри загальної області

Назва параметраОпис
async
ТипБулеве
Типове значенняTrue
Доступний з версії1.6

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

Пов'язаний параметр командного рядка: --async, --no-async

colorful-output
ТипБулеве
Типове значенняTrue

Встановіть для цього параметра значення false, щоб вимкнути розфарбування даних, які виводитиме kdesrc-build. Зауважте, що kdesrc-build не виводитиме розфарбовані дані до інших, відмінних від термінала (на зразок xterm, Konsole або звичайної консолі Linux®), виводів.

Пов'язаний параметр командного рядка: --color (або --colorful-output), --no-color (або --no-colorful-output)

disable-agent-check
ТипБулеве
Типове значенняFalse

Якщо ви використовуєте SSH для отримання вихідних кодів Git (наприклад, якщо ви використовуєте протокол git+ssh), цей параметр керує тим, чи намагатиметься kdesrc-build перевірити і зробити так, щоб, якщо ви використовуєте агент ssh, цей агент справді керував певними профілями SSH. Так зроблено, щоб SSH не надсилав, за можливості, запитів на пароль для кожного з ваших модулів.

Пов'язані параметри командного рядка: --disable-agent-check, --no-disable-agent-check

git-desired-protocol
ТипРядок
Типове значенняgit
ЖурналЦей параметр було додано у kdesrc-build 1.16. До версії 20.06 цей параметр використовувався для налаштовування адреси отримання даних, а не адреси надсилання даних. З версії 20.06 для оновлення проєктів KDE завжди використовується https.

Цей параметр стосується модулів зі сховища проєкту KDE.

Насправді, за допомогою цього параметрам можна вказати, якому з протоколів роботи у мережі слід надавати перевагу під час оновлення початкових кодів відповідних модулів. Зазвичай, використовується дуже ефективний протокол git, але його може бути заблоковано у деяких мережах (наприклад у корпоративних мережах, відкритих мережах Wi-Fi). Альтернативним протоколом з ширшою підтримкою є https, який використовується для доступу до сайтів інтернету.

Якщо ви користуєтеся якоюсь з мереж з обмеженнями, ви можете встановити для цього параметра значення http, щоб наказати програмі надавати перевагу передаванню даних за допомогою https.

Підказка

Крім того, у вас може виникнути потреба у встановленні значення для параметра http-proxy, якщо для роботи з даним використовується проксі-сервер HTTP.

У всіх інших випадках не варто встановлювати цей параметр, оскільки типовий протокол є найефективнішим.

git-repository-base
ТипРядок
Доступний з версії1.12.1

Цей параметр використовується для скорочення посилань на базову адресу певного сховища Git у наступних оголошеннях наборів модулів. Параметр корисний для оголошення збирання декількох модулів Git.

Вам слід вказати два значення (відокремлених пробілами): назву, яку буде пов’язано з базовою адресою, та саму базову адресу. Приклад:

global
# інші параметри
# Загальна адреса всіх модулів сервера Git з анонімним доступом.
git-repository-base kde-git kde:
end global

# Оголошення модулів

module-set
# Тепер можна скористатися раніше визначеним псевдонімом, але лише
# у межах module-set.
repository kde-git
use-modules модуль1.git модуль2.git
end module-set

Параметр use-modules набору модулів створив два записи модулів. kdesrc-build поводитиметься так, наче було вказано:

module модуль1
    repository kde:модуль1.git
end module

module модуль2
    repository kde:модуль2.git
end module

Префікс сховища Git kde:, використаний вище, є скороченням, яке буде автоматично встановлено kdesrc-build. Щоб дізнатися більше, ознайомтеся зі статтею TechBase щодо перейменування адрес. Зауважте, що на відміну від більшості інших параметрів, цей параметр може бути вказано декілька разів з метою визначення потрібних вам замінників адрес.

Підказка

Для того, щоб скористатися перевагами наборів модулів, не обов’язково використовувати цей параметр. Цей параметр призначено лише для спрощення використання одного сховища у декількох наборах модулів.

install-environment-driver
ТипБулеве
Типове значенняTrue
Доступний з версії17.08

Встановити скрипт оболонки, яким можна скористатися у скриптах налаштовування профілю користувача для спрощення визначення бажаних змінних середовища для запуску стільниці Плазми, зібраної за допомогою kdesrc-build.

Цим драйвером буде внесено зміни до таких файлів:

  • $XDG_CONFIG_HOME/kde-env-master.sh (зазвичай зберігається за адресою ~/.config/kde-env-master.sh).

  • $XDG_CONFIG_HOME/kde-env-user.sh (зазвичай зберігається за адресою ~/.config/kde-env-user.sh).

Скрипт kde-env-user.sh є необов'язковим. Його призначено для налаштовування користувачем (див. розділ Troubleshooting and Debugging сторінки UserBase KDE, де наведено приклади параметрів налаштовування), але ці параметри можна встановити у інший спосіб користувачем у скриптах налаштовування наявного профілю.

Ви можете вимкнути драйвер встановленням для цього параметра значення false і та вимиканням параметра install-session-driver.

Підказка

kdesrc-build не перезаписуватиме вже створених файлів (якщо такі існують), якщо ви не передасте програмі параметр командного рядка --delete-my-settings.

Пов'язані параметри командного рядка: --install-environment-driver, --no-install-environment-driver

install-session-driver
ТипБулеве
Типове значенняTrue
Доступний з версії1.16

Якщо увімкнено, kdesrc-build намагається встановити драйвер до графічної програми для керування сеансами для того, щоб уможливити ваш вхід до зібраного за допомогою kdesrc-build стільничного середовища KDE.

Цим драйвером буде внесено зміни до таких файлів:

  • ~/.xsession

  • $XDG_CONFIG_HOME/kde-env-master.sh (зазвичай зберігається за адресою ~/.config/kde-env-master.sh).

  • $XDG_CONFIG_HOME/kde-env-user.sh (зазвичай зберігається за адресою ~/.config/kde-env-user.sh).

Якщо ви користуєтеся власним драйвером для входу до середовища, ви можете вимкнути драйвер встановленням для цього параметра значення false. Якщо її увімкнено, ця можливість також вмикає можливість install-environment-driver.

Підказка

kdesrc-build не перезаписуватиме вже створених файлів (якщо такі існують), якщо ви не передасте програмі параметр командного рядка --delete-my-settings.

Пов'язані параметри командного рядка: --install-session-driver, --no-install-session-driver

niceness
ТипЦіле
Типове значення10

Значенням цього параметра є ціле число у діапазоні від 20 до 0. Чим вищим буде це число, тим нижчим встановлюватиметься пріоритет процесу kdesrc-build, тобто, чим вищим є число, тим вищим є «пріоритет» програми.

Пов'язаний параметр командного рядка: --nice (або --niceness) значення

num-cores
ТипЦіле
Типове значенняЗалежить від системи
Доступний з версії20.07

Цей параметр визначається kdesrc-build (при використанні kdesrc-build --generate-config). Його значенням є кількість доступних процесорів (яку буде встановлено за допомогою зовнішньої програми nproc). Якщо kdesrc-build не вдасться визначити кількість процесорів, для цього параметра буде встановлено значення 4.

Див. Приклад 2.1, «Налаштовування Make на компіляцію з використанням усіх доступних процесорів з виключеннями», де наведено приклад використання цього параметра.

Пов'язаний параметр командного рядка: --num-cores значення

num-cores-low-mem
ТипЦіле
Типове значенняЗалежить від системи
Доступний з версії20.07

Цей параметр визначається kdesrc-build (при використанні kdesrc-build --generate-config). Його значенням кількість процесорів, яку безпечно використовувати для великих або інтенсивних з точки зору обробки модулів, зокрема qtwebengine, щоб уникнути надмірного споживання пам'яті під час збирання.

Типовою формулою є одне ядро процесора на кожні 2 гігабайти (ГіБ) загальної пам'яті. Буде визначено принаймні 1 ядро і не більше, ніж num-cores ядер.

Хоча цей параметр було реалізовано для підтримки модулів Qt™, ви можете скористатися ним для будь-якого модуля у той самий спосіб, у який використовується num-cores.

Якщо kdesrc-build не може визначити доступний обсяг пам'яті, для цього параметра буде встановлено значення 2.

Пов'язаний параметр командного рядка: --num-cores-low-mem значення

persistent-data-file
ТипРядок
Доступний з версії1.15

За допомогою цього параметра можна змінити місце, у якому зберігатимуться постійні дані kdesrc-build. Типово, ці дані зберігатимуться у файлі з назвою .kdesrc-build-data, який зберігатимуться у тому самому каталозі, що і файл налаштувань, який використовує програма. Якщо використано загальний файл налаштувань, його буде збережено до ~/.local/state/kdesrc-build-data ($XDG_STATE_HOME/kdesrc-build-data, якщо встановлено значення $XDG_STATE_HOME). Якщо ви користуєтеся декількома наборами налаштувань, вам варто встановити значення цього параметра вручну, щоб різні набори налаштувань не призводили до конфлікту між наборами постійних даних.

Пов'язаний параметр командного рядка: --persistent-data-file файл

ssh-identity-file
ТипРядок
Доступний з версії1.14.2

Встановіть значення цього параметра, якщо потрібно вказати, який саме файл ключа SSH слід передати програмі ssh-add під час отримання за допомогою kdesrc-build коду зі сховищ, для доступу до яких потрібно пройти розпізнавання. Також варто ознайомитися з розділом «Перевірки агента SSH».

use-idle-io-priority
ТипБулеве
Типове значенняFalse
Доступний з версії1.12

Вжити зменшення пріоритетності використання скриптом диска та інших інструментів вводу-виводу, це може значно покращити швидкодію решти системи під час роботи скрипту за рахунок збільшення часу роботи kdesrc-build.

Пов'язані параметри командного рядка: --use-idle-io-priority, --no-use-idle-io-priority

use-inactive-modules
ТипБулеве
Типове значенняFalse

Дозволити kdesrc-build також клонувати і отримувати дані зі сховищ, які позначено як неактивні.

Пов'язані параметри командного рядка: --use-inactive-modules, --no-use-inactive-modules


Таблиця 4.2. Параметри усіх областей (модуля, набору модулів та загальні)

Назва параметраОпис
binpath
ТипРядок

Встановіть для цього параметра значення, щоб визначити значення змінної середовища PATH на час збирання. Ви не зможете перевизначити значення цього параметра для окремого модуля. Типовим значенням параметра є $PATH, змінна, значення якої встановлюється під час запуску. Значенням цієї змінної середовища має бути відокремлений двокрапками список шляхів до ваших каталогів для збирання. Шляхи ${install-dir}/bin і ${qt-install-dir}/bin буде додано автоматично. Ви можете додати тильду (~) для всіх шляхів, які ви додаєте за допомогою цього параметра.

Пов'язаний параметр командного рядка: --binpath шлях

branch
ТипРядок
Типове значенняmaster

Отримати дані з вказаної гілки, а не типової гілки.

Примітка

Для більшості модулів KDE, ймовірно, варто користуватися замість цього параметра параметром branch-group, а цей параметр використовувати лише для створення виключень з правил.

Пов'язаний параметр командного рядка: --branch значення

branch-group
ТипРядок
Доступний з версії1.16-pre2

Для цього параметра слід встановити значення загальної групи, з якої слід вибирати модулі.

Для підтримуваних типів модулів Git kdesrc-build визначити справжню гілку, яку слід автоматично використовувати на основі створених розробниками KDE правил (ці правила можна переглянути у підкаталозі kde-build-metadata каталогу початкового коду kdesrc-build). Після визначення гілки цю гілку буде використано так, наче ви вказали усі гілки власноруч за допомогою параметра branch.

Цей параметр корисний, якщо ви просто хочете підтримувати актуальність певної гілки розробки, не бажаючи приділяти надмірну увагу усім змінам у назвах гілок.

Зауважте, що якщо ви виберете значення branch власноруч, воно матиме вищий пріоритет за значення цього параметра. Те саме стосується і інших параметрів вибору гілки для окремого пакунка, зокрема параметра tag.

Примітка

Цим параметром можна скористатися (у типовому випадку) лише для модулів Git kde-projects. Див. також «Офіційна база даних модулів KDE».

Пов'язаний параметр командного рядка: --branch-group значення

build-dir
ТипРядок
Типове значення~/kde/build

Скористайтеся цим параметром, щоб змінити каталог, у якому зберігатиметься програмний код для збирання. Передбачено три різних способи його використання:

  1. Відносний щодо каталогу початкових кодів KDE Git (див. параметр source-dir). Це типове значення, його буде вибрано, якщо ви вкажете назву каталогу, яка не починається з тильди (~) або символу похилої риски (/).

  2. Абсолютний шлях. Якщо ви вкажете шлях, який починається з /, цей шлях буде використано безпосередньо. Приклад: /tmp/kde-obj-dir/.

  3. Відносний щодо вашого домашнього каталогу. Якщо ви вкажете шлях, який починається з a ~, шлях вважатиметься відносним щодо вашого домашнього каталогу, подібно до розгортання тильди у командній оболонці. Наприклад, ~/builddir вказуватиме каталог збирання /home/ім'я_користувача/builddir.

Можливо, несподівано, але цей параметр можна змінювати для окремих модулів.

Пов'язаний параметр командного рядка: --build-dir шлях

build-when-unchanged
ТипБулеве
Типове значенняTrue

Керувати тим, чи буде kdesrc-build завжди намагатися зібрати модуль, у якому не було оновлення початкових кодів.

Якщо встановлено значення true, kdesrc-build завжди виконуватиме збирання модуля, навіть якщо ніякого оновлення коду модуля не відбулося. Із цим значенням ймовірність належних результатів збирання буде вищою.

Якщо встановлено значення false, kdesrc-build виконуватиме спроби збирання модуля, лише якщо у коді модуля відбулися зміни, або у інших випадках, коли повторне збирання є насправді необхідним. Подібна поведінка може зекономити вам час, особливо якщо ви запускаєте kdesrc-build щоденно або навіть частіше.

Важливо

Цей параметр призначено лише для оптимізації збирання. Подібно до значної частини оптимізацій, його використання може позначитися на коректності збирання. Наприклад, зміни, внесені до модулів qt або kdelibs, можуть призвести до необхідності повторного збирання інших модулів, навіть якщо їх початкові коди не зазнали змін взагалі.

Пов'язаний параметр командного рядка: --build-when-unchanged (або --force-build), --no-build-when-unchanged (або --no-force-build)

cmake-generator
ТипРядок
Типове значенняMakefile Unix

За допомогою цього параметра можна визначити, який засіб створення даних буде використано у поєднанні із CMake. У поточній версії передбачено підтримку як Ninja, так і файлів Make Unix, а також додаткових генераторів на їхній основі, зокрема Eclipse CDT4 - Ninja. Некоректні (непідтримувані) значення буде проігноровано — значення вважатиметься невстановленим.

Зауважте, що якщо коректний засіб обробки також вказано за допомогою cmake-options, він матиме пріоритет над цим значенням для cmake-generator.

Пов'язаний параметр командного рядка: --cmake-generator значення

cmake-toolchain
ТипРядок

Вказати файл набору інструментів, яким слід скористатися у CMake.

Якщо налаштовано коректний набір інструментів, kdesrc-build не встановлюватиме змінні середовища автоматично. Для виправлення середовища вручну ви можете скористатися set-env, binpath та libpath, якщо файл набору інструментів не працює у kdesrc-build без вашого втручання. Щоб дізнатися про це більше, зверніться до огляду стандартних прапорців, які додаються kdesrc-build.

Зауважте, що якщо коректний набір інструментів також вказано за допомогою cmake-options, він матиме пріоритет над цим значенням для cmake-toolchain.

Пов'язаний параметр командного рядка: --cmake-toolchain значення

cmake-options
ТипРядок

Дописує дані до загальних параметрів для типової системи збирання і перевизначає загальні параметри для інших систем збирання.

Скористайтеся цим параметром для того, щоб визначити, які параметри слід передати CMake під час створення системи збирання модуля. Якщо цей параметр використано як загальний, його буде застосовано до всіх модулів, які збирає цей скрипт. Якщо параметр визначено на рівні модуля, його буде додано в кінець загальний параметрів. За допомогою цього параметра можна вказати загальні параметри CMake у загальному розділі (global).

Значення цього параметра не стосується qt (CMake там не використовується). Скористайтеся для збирання qt configure-flags.

Якщо серед параметрів цього списку буде вказано коректний засіб створення даних, він матиме пріоритет над значенням cmake-generator. Некоректні (або непідтримувані) значення запису засобу створення даних буде проігноровано — їх не буде передано CMake.

Якщо серед параметрів цього списку буде вказано коректний файл набору інструментів, він матиме пріоритет над значенням cmake-toolchain. Некоректні (або непідтримувані) значення запису набору інструментів буде проігноровано — їх не буде передано CMake.

Оскільки ці параметри передаються безпосередньо до командного рядка CMake, їх слід вказувати у тому самому вигляді, у якому їх буде передано CMake. Приклад:

cmake-options -DCMAKE_BUILD_TYPE=RelWithDebInfo

Оскільки встановлення цього параметра потребує певних знань, якщо всі інші параметри kdesrc-build вказано правильно, ви можете просто залишити значення цього параметра порожнім. (Іншими словами, потрібні параметри CMake буде встановлено автоматично)

Пов'язаний параметр командного рядка: --cmake-options значення

compile-commands-export
ТипБулеве
Типове значенняTrue

Вмикає створення compile_commands.json у каталозі збирання за допомогою CMake.

Пов'язані параметри командного рядка: --compile-commands-export, --no-compile-commands-export

compile-commands-linking
ТипБулеве
Типове значенняFalse

Вмикає створення символічних посилань з compile_commands.json, створеного у каталозі збирання за допомогою, на відповідний каталог початкового коду.

Пов'язані параметри командного рядка: --compile-commands-linking, --no-compile-commands-linking

configure-flags
ТипРядок

Дописує дані до загальних параметрів для типової системи збирання і перевизначає загальні параметри для інших систем збирання.

Скористайтеся цим параметром, щоб вказати параметри, які слід передати ./configure під час створення системи збирання модуля. Якщо цей параметр використовується на загальному рівні, його буде застосовано до всіх модулів, які збиратимуться цим скриптом. Цей параметри потрібен лише для qt-copy..

Щоб змінити параметри налаштування модулів KDE, ознайомтеся з розділом щодо cmake-options.

Пов'язаний параметр командного рядка: --configure-flags значення

custom-build-command
ТипРядок

За допомогою цієї команди можна наказати системі виконати іншу команду (відмінну від, наприклад, make) з метою збирання. Зазвичай, програма kdesrc-build здатна сама вибрати команду для збирання, отже немає потреби у визначенні цього параметра. Втім, він може бути корисним у разі використання альтернативних систем збирання.

Значення цього параметра використовується як команда, яку слід виконати. Зміни до команди вносяться за допомогою параметра make-options у звичайному режимі.

Пов'язаний параметр командного рядка: --custom-build-command значення

cxxflags
ТипРядок

Дописує дані до загальних параметрів для типової системи збирання і перевизначає загальні параметри для інших систем збирання.

Скористайтеся цим параметром, щоб вказати, які параметри слід використовувати для збирання модуля. Цей параметр визначається саме тут, а не у параметрах configure-flags і cmake-options, оскільки цей параметр також встановлює змінну середовища CXXFLAGS під час процесу збирання.

Зауважте, що у KDE 4 і всіх інших модулів, які використовують CMake, потрібно встановити значення параметра CMAKE_BUILD_TYPE рівним none під час налаштування модуля. Зробити це можна за допомогою параметра cmake-options.

Пов'язаний параметр командного рядка: --cxxflags значення

dest-dir
ТипРядок

Скористайтеся цим параметром, щоб змінити назву, яку буде дано модулю на диску. Наприклад, якщо вам потрібен модуль extragear/network, за допомогою цього параметра ви можете перейменувати його на extragear-network. Зауважте, що не варто включати до назви модуля каталоги роздільники каталогів, оскільки такі назви можуть призвести до конфлікту з одним з параметрів build-dir або source-dir.

Пов'язаний параметр командного рядка: --dest-dir шлях

do-not-compile
ТипРядок

Скористайтеся цим параметром, щоб вибрати певний набір каталогів, які не буде зібрано у модулі (замість збирання всіх каталогів). Відокремлювати каталоги у списку слід за допомогою пробілів.

Зауважте, що вихідні коди програм все ж буде отримано.

Наприклад, щоб вимкнути збирання у каталогах codeeditor і minimaltest бібліотеки syntaxhighlighting, вам слід додати компіляцію do-not-compile codeeditor minimaltest, вам слід додати «do-not-compile juk kscd» до ваших параметрів syntaxhighlighting.

Приклад можна знайти у розділі «Вилучення каталогів з процесу збирання».

Пов'язаний параметр командного рядка: --do-not-compile значення

git-user
ТипРядок
Доступний з версії15.09

Цей параметр призначено для розробників KDE. Якщо його встановлено, значення буде використано для автоматичного налаштовування даних профілю системи керування версіями Git для нових отриманих модулів Git (більшості модулів KDE).

Зокрема, вказаними за допомогою цього параметра значеннями буде заповнено поля імені користувача та адреси електронної пошти для кожного нового сховища Git.

Значення має бути вказано у форматі Ім’я користувача <адреса@електронної.пошти>.

Наприклад, якщо розробника звати «Bozna Khto», а адресою є «bozna@abc.xyz», слід вказати таке:

git-user Bozna Khto <bozna@abc.xyz>

http-proxy
ТипРядок
Доступний з версії1.16

Цей параметр, якщо його встановлено, використовується для визначення адреси проксі-сервера, яким слід користуватися для обміну даними у мережі за допомогою HTTP (наприклад під час отримання бази даних проєктів KDE).

Крім того, kdesrc-build намагатиметься використати проксі-сервер для роботи інших програм, від дій яких залежить працездатність програми. Отже, для змінної середовища http_proxy буде встановлене значення позначеного сервера, якщо для цієї змінної ще не встановлено жодного значення.

Пов'язаний параметр командного рядка: --http-proxy значення

directory-layout
ТипРядок
Коректні значенняflat, invent, metadata
Типове значенняflat

За допомогою цього параметра можна налаштувати компонування, яким kdesrc-build користуватиметься при створенні каталогів із початковим кодом та каталогів для збирання.

Якщо буде використано компонування flat, програма згрупує усі модулі безпосередньо у каталогах початкового коду та збирання. Наприклад, source/extragear/network/telepathy/ktp-text-ui у компонуванні metadata буде просто source/ktp-text-ui, якщо ви скористаєтеся замість нього компонуванням flat.

Якщо буде використано компонування invent, програма створить ієрархію каталогів, яка точно збігатиметься із відносними шляхами сховищ на invent.kde.org. Наприклад, source/kde/applications/kate у компонуванні metadata буде source/utilities/kate, якщо ви скористаєтеся замість нього компонуванням invent. Це компонування стосується лише проєктів KDE. Це непоганий варіант для тих, хто лише розпочинає роботу з kdesrc-build.

Нарешті, компонування metadata відтворює типову поведінку попередніх версій програми. У цьому компонуванні проєкти KDE упорядковуються відповідно до шляхів проєктів, які вказано у метаданих проєктів для цих модулів. Це непоганий варіант, якщо вам потрібне компонування каталогів, яке відтворюватиме певні процеси розробки KDE. Це, втім, означатиме, що відповідні шляхи не лишатимуться сталими. У результаті цього, kdesrc-build може «забути» про стару копію сховища і клонувати сховище для проєкту знову через зміни у метаданих проєкту.

Пов'язаний параметр командного рядка: --directory-layout значення

generate-vscode-project-config
ТипБулеве
Типове значенняFalse

Параметр модуля перевизначає загальний параметр

Встановіть для цього параметра значення true, щоб наказати kdesrc-build створити файли проєкту VS Code (каталог .vscode directory) у каталозі початкового коду модуля.

У каталозі початкового коду проєкту буде створено теку .vscode, лише якщо її ще не існувало. У налаштуваннях буде уможливлено користування LSP, збирання, діагностику та запуск проєкту з VS Code.

У налаштуваннях також рекомендовано розширення, які варто встановити для роботи з більшістю проєктів KDE.

Пов'язаний параметр командного рядка: --generate-vscode-project-config, --no-generate-vscode-project-config

include-dependencies
ТипБулеве
Типове значенняTrue

Керує тим, чи слід kdesrc-build включити відомі залежності модуля до його налаштувань збирання, без потреби у явному визначенні цих залежностей (навіть опосередковано).

Примітка

Цей параметр працюватиме лише для модулів на основі kde-project і потребує від розробників KDE точного визначення метаданих для вибраної вами групи гілок.

Для забезпечення підтримки збирання програм, які потребують версій Qt™ або Плазми, які є новішими за ті, підтримку яких передбачено у типових операційних системах.

Пов'язаний параметр командного рядка: --include-dependencies (або -d), --no-include-dependencies (або -D)

install-after-build
ТипРядок
Типове значенняTrue

Цей параметр використовується для встановлення пакунка після його успішного збирання. Крім того, ви можете скористатися параметром командного рядка --no-install.

Пов'язані параметри командного рядка: --install-after-build, --no-install-after-build

install-dir
ТипРядок
Типове значення~/kde/usr

За допомогою цього параметра можна визначити каталог, до якого буде встановлено модуль після збирання. Якщо ви зміните значення так, що воно вказуватиме на каталог, для доступу до якого потрібні права користувача root, ймовірно, вам слід прочитати і про параметр make-install-prefix.

Зміна значення цього параметра для певного модуля надає вам змогу встановити модуль у каталог, що не збігається з каталогом бібліотек Платформи KDE, якщо ви, наприклад, використовуєте kdesrc-build лише для збирання певних програм.

Ви можете замінити назву модуля у шляхах за допомогою синтаксичної конструкції ${MODULE} або $MODULE.

Пов'язаний параметр командного рядка: --install-dir шлях

libname
ТипРядок
Типове значенняАвтовиявлення

Встановіть значення цього параметра, щоб змінити типову назву каталогу встановлених бібліотек у ${install-dir} і ${qt-install-dir}. У багатьох системах це або «lib», або «lib64». Типово, буде виконано спробу автоматичного визначення належної назви, але якщо програма визначає помилкову назву, її можна змінити за допомогою цього параметра.

Пов'язаний параметр командного рядка: --libname значення

libpath
ТипРядок

Встановіть значення для цього параметра значення, щоб змінити значення змінної середовища LD_LIBRARY_PATH на час збирання. Ви не зможете перевизначити цей параметр на рівні модулів. Типовим є порожнє значення, але шляхи ${install-dir}/$LIBNAME і ${qt-install-dir}/$LIBNAME буде додано автоматично. Ви можете скористатися тильдою (~) у будь-якому зі шляхів, які ви додасте за допомогою цього параметра.

Пов'язаний параметр командного рядка: --libpath шлях

log-dir
ТипРядок

Скористайтеся цим параметром, щоб змінити каталог, у якому зберігатимуться файли журналу, створені скриптом.

Пов'язаний параметр командного рядка: --log-dir шлях

make-install-prefix
ТипРядок

Встановіть для цієї змінної значення відокремленого пробілами списку, який скрипт вважатиме командою і її параметрами, які передують команді make install, призначеній для встановлення модулів. Наприклад, цей параметр буде корисним для встановлення пакунків за допомогою Sudo, але, будь ласка, будьте обережними з використанням прав доступу адміністративного користувача.

Пов'язаний параметр командного рядка: --make-install-prefix значення

make-options
ТипРядок

Встановіть значення для цієї змінної, щоб передати параметри командного рядка команді make. Подібні параметри будуть корисним для програм на зразок distcc або у системах з декількома процесорними ядрами.

Зауважте, що make використовується не в усіх системах збирання. Якщо для збирання використовується ninja (так, зокрема, побудовано систему збирання Meson), скористайтеся параметром ninja-options.

Пов'язаний параметр командного рядка: --make-options значення

manual-build
ТипБулеве
Типове значенняFalse

Встановіть для цього параметра значення true, щоб під час процесу збирання скрипт не намагався зібрати цей модуль. Модуль все ж буде оновлено під час оновлення зі сховища Git. Цей параметр у точності збігається з параметром командного рядка --no-build.

manual-update
ТипБулеве
Типове значенняFalse

Встановіть для цього параметра значення true, щоб процес збирання не намагався оновити (і отже зібрати і встановити) цей модуль. Якщо ви встановите цей параметр для певного модуля, вам варто закоментувати його.

ninja-options
ТипРядок

Встановіть значення для цієї змінної, щоб передати параметри командного рядка для команди збирання ninja. За допомогою цього значення можна увімкнути «докладний» режим виведення даних або вручну зменшити кількість паралельних завдань зі збирання для ninja.

Примітка

Зауважте, що значення цього параметра використовується для керування ninja лише у kdesrc-build. Модуль «webengine» Qt™ використовує ninja опосередковано, а офіційно збирається лише за допомогою make. У таких випадках ви можете, скориставшись make-options, встановити значення змінної NINJAFLAGS, щоб make передала відповідні прапорці під час наступного виклику ninja.

options qtwebengine
    # Обмежуємо make і ninja використання не більше 6 окремих завдань зі збирання,
    # навіть якщо доступними є багато процесорів, щоб уникнути вичерпання пам'яті
    make-options -j6 NINJAFLAGS=-j6
end options

Пов'язаний параметр командного рядка: --ninja-options значення

override-build-system
ТипРядок
Типове значенняАвтовиявлення
Коректні значенняKDE, Qt, qmake, generic, autotools, meson
Доступний з версії1.16

Зазвичай, kdesrc-build автоматично визначає систему збирання, яку слід використати для модуля, після отримання його коду. Визначення виконується за допомогою пошуку специфічних файлів у каталозі з кодами модуля.

Деякі модулі можуть містити більше за один набір файлів, що може призвести до помилок під час автоматичного визначення. У таких випадках слід вказати тип системи збирання вручну.

Серед типів систем збирання, передбачених у поточній версії, слід відзначити такі:

KDE

Використовується для збирання модулів KDE. Насправді, можна використовувати для збирання майже будь-яких модулів, де використовується CMake, але краще на це не покладатися.

Qt

Призначено для збирання самої бібліотеки Qt™.

qmake

Використовується для збирання модулів Qt™, у яких використано файли qmake, .pro.

generic

Використовується для збирання модулів, у яких використовуються звичайні файли Makefile і які не потребують додаткового налаштовування.

autotools

Стандартний інструмент налаштування для більшості вільних проєктів з розробки програмного забезпечення з відкритим кодом, які не належать до інших категорій.

meson

Це відносно новий інструмент, який набуває популярності як замінник autotools і який може знадобитися для збирання деяких з модулів, які не є частиною KDE.

Пов'язаний параметр командного рядка: --override-build-system значення

purge-old-logs
ТипБулеве
Типове значенняTrue

За допомогою цього параметра можна наказати скрипту автоматично вилучати старі каталоги журналів або не робити цього.

Пов'язані параметри командного рядка: --purge-old-logs, --no-purge-old-logs

qmake-options
ТипРядок
Доступний з версії1.16

Усі вказані тут параметри буде передано програмі qmake для модулів, у яких використовується система збирання qmake. Наприклад, ви можете скористатися параметром qmake PREFIX=/шлях/до/qt, для перевизначення місця, куди буде встановлено модуль.

Пов'язаний параметр командного рядка: --qmake-options значення

qt-install-dir
ТипРядок

Цей параметр керує тим, куди буде встановлено модулі qt після збирання. Якщо ви не вкажете значення для параметра, kdesrc-build вважатиме, що слід використовувати бібліотеки Qt™ з операційної системи.

Пов'язаний параметр командного рядка: --qt-install-dir шлях

remove-after-install
ТипРядок
Коректні значенняnone, builddir, all
Типове значенняnone

Якщо на жорсткому диску вашого комп’ютера мало місця, ймовірно, вам слід скористатися цим параметром для того, щоб автоматично вилучити каталог збирання (або одночасно каталоги кодів зі збирання для одноразового встановлення) після того, як модуль буде успішно встановлено.

Можливими значення цього параметра є:

  • none — Нічого не вилучати.

  • builddir — Вилучити каталог збирання, але не початкових кодів.

  • all — Вилучити каталоги початкових кодів і збирання.

Зауважте, що використання цього параметра призведе до збільшення використання вашого каналу з’єднання (якщо ви використовуєте all) і часу, який буде використано для збирання програмного забезпечення KDE, оскільки kdesrc-build не зможе виконувати покрокове збирання.

Пов'язаний параметр командного рядка: --remove-after-install значення

repository
ТипРядок
Доступний з версії1.10

За допомогою цього параметра можна вказати сховище Git, звідки слід отримувати коди модуля. Цей параметр потрібен для Qt™ (і отже qt), а також різноманітних модулів KDE, які перебувають у стані переходу на використання Git.

revision
ТипРядок
Доступний з версії1.16

Якщо встановити для цього параметра значення, відмінне від 0 (нуля), kdesrc-build примусово виконає оновлення початкового коду до точно вказаної версії модуля, навіть якщо діють параметри на зразок branch. Якщо ви вже маєте модуль вказаної версії, його не буде оновлено до того часу, доки цей параметр налаштування не буде змінено або вилучено.

Пов'язаний параметр командного рядка: --revision ідентифікатор

run-tests
ТипБулеве
Типове значенняFalse

Якщо значенням цього параметра буде true, модуль буде зібрано з підтримкою запуску комплексу тестів, комплекс тестів буде виконано у процесі збирання. kdesrc-build покаже вам спрощений звіт щодо результатів тестування. Цей параметр буде корисним для розробників або тих, хто бажає переконатися, що систему налаштовано належним чином.

Пов'язані параметри командного рядка: --run-tests, --no-run-tests

set-env
ТипРядок

Цей параметр приймає розділений пробілами набір значень, де перше значення є змінною середовища, яку слід встановити, а решта значень вважатиметься значенням змінної. Наприклад, щоб встановити для змінної RONALD значення McDonald, вам слід вказати у відповідному розділі таку команду:

set-env RONALD McDonald

Цей параметр має особливість: його можна повторювати без перевизначення раніше встановлених параметрів set-env у одному і тому ж розділі файла налаштувань. Таким чином, ви можете встановити декілька змінних середовища у одному модулі (або загальних змінних).

source-dir
ТипРядок
Типове значення~/kde/src

Цей параметр використовується для встановлення каталогу, у якому Git слід зберігати коди KDE. Ви можете скористатися тильдою (~) для позначення домашнього каталогу.

Пов'язаний параметр командного рядка: --source-dir шлях

stop-on-failure
ТипБулеве
Типове значенняTrue

Встановлення для цього параметра значення false надає змогу продовжити виконання скрипту, якщо під час збирання або встановлення трапляться помилки.

Пов'язаний параметр командного рядка: --stop-on-failure, --no-stop-on-failure

теґ
ТипРядок
Доступний з версії1.16

Використовуйте цей параметр для отримання певної версії модуля.

Зауваження: ймовірно, вам не доведеться використовувати цей параметр. Випуски KDE можна отримати у форматі архівів з сайта отримання пакунків KDE.

Пов'язаний параметр командного рядка: --tag значення

use-clean-install
ТипБулеве
Типове значенняFalse
Доступний з версії1.12

Встановіть для цього параметра значення true, якщо kdesrc-build слід виконати make uninstall безпосередньо перед виконанням команди make install.

Цей параметр може бути корисним для забезпечення вилучення застарілих файлів бібліотек, метаданих CMake тощо, які можуть призвести до проблем у екземплярах KDE, які мають довгу історію. Втім, цей параметр допоможе позбутися зайвих даних лише у системах збирання, у яких передбачено підтримку виконання команди make uninstall.

Пов'язані параметри командного рядка: --use-clean-install, --no-use-clean-install


Для цих параметрів не потрібно передавати жодних значень (окрім «filter-out-phases»). Їх буде застосовано, якщо ви вкажете їх у розділі.

Таблиця 4.3. Параметри вибору фази

Назва параметраОбласть діїОпис
no-src
global
module
module-set

Вилучити фазу update. Інші вказані фази буде оброблено.

Пов'язаний параметр командного рядка: --no-src (або -S)

no-install
global
module
module-set

Вилучити фазу install. Інші вказані фази буде оброблено.

Пов'язаний параметр командного рядка: --no-install

no-tests
global
module
module-set

Вилучити фазу test. Інші вказані фази буде оброблено.

Пов'язані параметри командного рядка: --no-tests

no-build
global
module
module-set

Вилучити фазу build. Інші вказані фази буде оброблено.

Пов'язаний параметр командного рядка: --no-build

build-only
global
module
module-set

Якщо була фаза build, вилучити усі інші фази. Якщо фази не було, вилучити усі фази взагалі.

Пов'язаний параметр командного рядка: --build-only

install-only
global
module
module-set

Якщо була фаза install, вилучити усі інші фази. Якщо фази не було, вилучити усі фази взагалі.

Пов'язаний параметр командного рядка: --install-only

uninstall
global
module
module-set

Якщо була фаза uninstall, вилучити усі інші фази. Якщо фази не було, вилучити усі фази взагалі.

Пов'язаний параметр командного рядка: --uninstall

filter-out-phases
global
module
module-set

Вилучити фази зі списку (відокремлені пробілами) в аргументах цього параметра. Інші вказані фази буде оброблено.


Таблиця 4.4. Параметри вибору модулів

Назва параметраОбласть діїОпис
ignore-modules
global
module-set
ТипРядок
Доступний з версії1.16

Зауважте, що якщо вказано у загальному розділі (global), параметр командного рядка --ignore-modules не має пріоритету над цим параметром, а лише доповнює його значення.

Модулі, названі у цьому параметрі, які мало б бути вибрано kdesrc-build через визначення параметра use-modules, буде повністю пропущено. Цим параметром можна скористатися, якщо ви хочете зібрати всі групи у проєкті kde-projects, окрім певних модулів.

Значення параметра не повинне обов’язково вказувати безпосередньо на назву модуля. Будь-який з модулів, повна частина шляху до модуля у проєктах KDE якого збігається з одним зі значень параметра, буде проігноровано. Отже, таким чином можна ігнорувати одразу декілька модулів.

Наприклад, значення параметра libs призведе до того, що буде виключено kde/kdegraphics/libs і playground/libs (але не kde/kdelibs, оскільки «kdelibs» не збігається повністю зі значенням параметра).

Пов'язаний параметр командного рядка: --ignore-modules (або -!) модуль [модуль ...]

use-modules
module-set
ТипРядок
Доступний з версії1.12.1

За допомогою цього параметра вам буде простіше вказати набір модулів, які збиратимуться на певному етапі, у файлі налаштування.

Всі ідентифікатори, передані цьому параметру, перетворюються у розгорнуту форму у модулі kdesrc-build. Значення параметра repository буде встановлено на основі даних щодо сховища набору модулів і назви-ідентифікатора модуля. Всі інші параметри, визначені у наборі модулів також буде скопійовано до створених записів модулів без змін.

Порядок, у якому модулі визначено у цьому параметрі, є важливим, оскільки це саме той порядок, у якому kdesrc-build оброблятиме створені записи модулів під час оновлення, збирання і встановлення. Всі модулі, визначені у певному наборі модулів, буде оброблено до переходу kdesrc-build до наступного після набору модулів модуля.

Якщо вам потрібно змінити параметри створеного модуля, просто оголосіть модуль ще раз після його визначення у наборі модулів і вкажіть нові параметри. Хоча таким чином ви внесете зміни до параметри модуля, модуль все одно буде оновлено і зібрано у порядку, вказаному у наборі модулів (тобто ви не зможете таким чином змінити порядок збирання).

Важливо

Якщо ви вирішите змінити параметри саме таким чином, назва модуля має збігатися з назвою, переданою use-modules, але частину .git слід прибрати.

Опис використання параметра і приклад можна знайти у розділах «Набори модулів» та git-repository-base.