Розділ 4. Налаштування kdesrc-build

Огляд налаштування kdesrc-build

Щоб скористатися цим скриптом, вам потрібен файл з назвою .kdesrc-buildrc, розташований у вашому домашньому каталозі, у цьому файлі описано модулі, які ви бажаєте отримати і зібрати, та усі параметри використання цих модулів.

Компонування файла налаштувань

Загальні налаштування

Файл налаштувань буде запущено з загальними параметрами, вказаними у такий спосіб:

global
назва_параметра значення_параметра
[...]
end global

Налаштування модулів

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

  • module назва_модуля
    назва_параметра значення_параметра
    [...]
    end module
    
  • module-set назва-набору-модулів
      repository kde-projects або git://host.org/path/to/repo.git
      use-modules назви-модулів
    
    # Можна встановити також інші параметри
    назва-параметра значення-параметра
    [...]
    end module-set
    

Важливо

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

Для модулів Git параметр назва_модуля має бути назвою модуля зі сховища Git KDE (наприклад kdeartwork або kde-wallpapers).

Для модулів Git назвою може бути будь-який рядок, якщо цей рядок не дублює інших назв модулів у налаштуваннях. Пам’ятайте, що розташування каталогів коду і збирання буде визначено на основі назви модуля, якщо ви не використаєте параметра dest-dir.

Але для наборів модулів Git назви-модулів мають відповідати справжнім модулям git modules у вибраному сховищі (параметр repository). Щоб дізнатися більше, ознайомтеся з довідкою щодо git-repository-base і use-modules.

Обробка значень параметрів

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

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

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

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

Приклад 4.1. Додавання вашого власного параметра для подальшого використання у налаштуваннях

global
  _ver 6  # ← ваша нетипова змінна (починається з підкреслювання)
  _kde ~/kde${_ver}  # ← нетипова змінна може містити іншу визначену змінну
  source-dir ${_kde}/src  # ← зауважте вкладену змінну (_kde → _ver), яку також буде замінено
end global

options kdepim
  log-dir /custom/path/logs${_ver} # ← нетипову змінну можна використовувати як стандартну
end options


Модулі «options»

Цей останній тип записів файла налаштувань, групи options, яким можна скористатися для записів module або module-set.

options назва_модуля
назва_параметра значення_параметра
[...]
end options

У групі options можна встановлювати значення параметрів так само, як у оголошенні модуля. Цю групу має бути пов’язано з наявним модулем. Усі параметри, встановлені за допомогою цієї групи, буде використано для перевизначення набору параметрів пов’язаного модуля.

Важливо

Пов’язана назва модуля має збігатися з назвою, даною у оголошенні options. Тому слід не уважно стежити за тим, щоб у назві не було друкарських помилок.

Це корисно, якщо треба оголосити повний набір module-set для модулів з використанням однакових параметрів, а потім скористатися групами options для внесення окремих змін.

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

Приклад 4.2. Приклад використання options

У нашому прикладі визначено збирання усіх модулів з групи мультимедійного програмного забезпечення KDE. Крім того, визначено використання іншої версії для програми KMix (наприклад, щоб перевірити, чи виправлено певну ваду). Це працює так:

module-set kde-multimedia-set
  repository kde-projects
  use-modules kde/kdemultimedia
  branch master
end module-set

# kmix є частиною групи kde/kdemultimedia, навіть якщо kmix раніше у файлі
# не згадувався, kdesrc-build врахує зміну.
options kmix
  branch KDE/4.12
end options

Тепер, якщо ви запустите kdesrc-build, усі мультимедійні програми KDE буде зібрано на основі коду з гілки «master» сховища з кодом, KMix буде зібрано зі старішої гілки «KDE/4.12». Оскільки використано options, нам не довелося створювати окремий список усіх інших мультимедійних програм KDE, щоб визначити для них правильне значення параметра гілки коду.


Примітка

Зауважте, що цю можливість реалізовано лише з версії kdesrc-build 1.16, а також у тестовій версії kdesrc-build для розробників з 12 січня 2014 року.

Включенні інших файлів налаштувань

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

Наприклад, ви можете вказати щось таке:

global
    include ~/common-kdesrc-build-options

    # Тут вкажіть специфічні параметри.

end global

Примітка

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

Ви можете скористатися змінними у значенні для включення інструкції:

global
  _ver 6
  source-dir ~/kde${_ver}/src
  ...
  persistent-data-file ~/kde${_ver}/persistent-options.json
end global

include ~/kde6/src/kdesrc-build/data/build-include/kf${_ver}-qt${_ver}.ksb

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

Далі наведено список параметрів, якими ви можете скористатися. Натисніть позначку параметра, щоб дізнатися про нього більше. Повний список параметрів наведено у розділі «Таблиця параметрів налаштування».

  • cmake-options, щоб визначити параметри налаштування модуля за допомогою CMake.

  • branch, щоб отримати код для стабільної версії, а не версії master.

  • configure-flags, щоб визначити параметри, згідно яких буде налаштовано модуль Qt™.

  • install-dir, щоб вказати каталог, куди буде встановлено KDE.

  • make-options, щоб передати параметри програмі Make (зокрема кількість процесорів, які слід використовувати).

  • qt-install-dir, щоб вказати каталог, куди буде встановлено Qt™.

  • source-dir, щоб змінити каталог призначення для отримання початкових кодів.