Параметри командного рядка

Загальне

--pretend (або --dry-run, або -p)

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

Примітка

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

Важливо

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

--include-dependencies (або -d), --no-include-dependencies (або -D)

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

Перелік доданих модулів визначатиметься записами у системі керування початковими кодами програм KDE. Див. «Офіційна база даних модулів KDE».

Відповідним параметром у файлі налаштувань є параметр include-dependencies.

Цей параметр типово увімкнено.

--ignore-modules (або -!) модуль [модуль ...]

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

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

--run (або --start-program) [-e|--exec назва] [-f|--fork] програма [параметри ...]

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

--revision ідентифікатор

За допомогою цього параметра можна наказати kdesrc-build отримати певну версію кожного з модулів Git, незалежно від параметрів branch, tag та revision вже встановлених для цих модулів.

Вам не варто користуватися цим параметром, він підтримується лише з міркувань сумісності зі старішими версіями скрипту.

--delete-my-patches, --no-delete-my-patches

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

Зазвичай, потреби у використанні цього параметра немає. Якщо у параметрі виникне потреба, kdesrc-build попросить вас перезапустити програму з ним.

--delete-my-settings, --no-delete-my-settings

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

У поточній версії цей параметр використовується лише для налаштовування xsession у програмі для керування сеансами. Зазвичай, потреби у використанні цього параметра немає. Якщо у параметрі виникне потреба, kdesrc-build попросить вас перезапустити програму з ним.

--<назва-параметра> значення

Ви можете скористатися цим параметром, щоб перевизначити відповідний параметр у вашому файлі налаштувань для кожного з модулів. Наприклад, щоб перевизначити значення параметра log-dir, вам слід вказати: --log-dirшлях/до/каталогу.

Примітка

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

---set-module-option-value <назва модуля>,<назва параметра>,<значення параметра>

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

Поновлення та зупинення

--resume-from (або --from, або -f) модуль

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

Примітка

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

Див. також --resume-after та «Поновлення збирання, яке завершилося помилкою або було скасоване». Вам слід надавати перевагу використанню цього параметра командного рядка, якщо ви виправили помилку збирання і бажаєте, щоб скрипт kdesrc-build завершив збирання.

--resume-after (або --after, або -a) модуль

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

Примітка

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

Див. також --resume-from та «Поновлення збирання, яке завершилося помилкою або було скасоване». Вам слід надавати перевагу використанню цього параметра командного рядка, якщо ви виправили помилку збирання, а також зібрали і встановили модуль власноруч, і бажаєте, щоб скрипт kdesrc-build розпочав з обробки наступного модуля.

--resume

Цим параметром можна скористатися для запуску kdesrc-build після аварійного завершення роботи програми під час збирання.

За допомогою цього параметра можна відновити збирання з модуля, під час збирання якого сталася критична помилка, на основі попереднього списку модулів, які очікують на збирання. Оновлення коду та метаданих буде вимкнено. Цей параметр призначено для випадків, коли проста помилка або невстановлена залежність призводить до неможливості зібрати модуль. Щойно помилку буде виправлено, а залежність встановлено, ви можете швидко повернутися до збирання модулів без додаткових вправ зі встановлення належних аргументів для параметрів --resume-from та --stop-before.

--stop-before (або --until) модуль

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

Наприклад, якщо порядок у звичайному списку збирання був таким: модульA, модульB, модульC, і вказано --stop-before модульB, kdesrc-build виконає збирання лише модуля модульA.

--stop-after (або --to) модуль

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

Наприклад, якщо порядок у звичайному списку збирання був таким: модульA, модульB, модульC, і вказано --stop-after модульB, kdesrc-build виконає збирання модулів модульA та модульB.

--stop-on-failure, --no-stop-on-failure

За допомогою цього параметра можна керувати тим, чи буде збирання припинено, якщо станеться помилка. Корисний, якщо виконується початкове налаштовування середовища для розробки. Типовою є поведінка --stop-on-failure. Ви можете її перевизначити, якщо хочете продовжити збирання решти модулів у наборі, щоб уникнути втрати часу, якщо проблема виникла лише з одним з цих модулів.

Див. також параметр файла налаштувань stop-on-failure.

--rebuild-failures

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

Примітка

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

Відомості щодо модулів

--query режим

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

Разом із цим параметром можна вказати «режим», одне з таких значень:

  • source-dir — наказує kdesrc-build вивести повний шлях до каталогу, де зберігається код модуля.

  • build-dir — наказує kdesrc-build вивести повний шлях до каталогу, де відбуватиметься процес збирання.

  • install-dir — наказує kdesrc-build вивести повний шлях до каталогу, куди буде встановлено модуль.

  • project-path — наказує kdesrc-build вивести розташування модуля у ієрархії сховищ із початковим кодом програм KDE. Докладний опис цієї ієрархії наведено у розділі «Офіційна база даних модулів KDE».

  • branch — наказує kdesrc-build вивести назву визначеної гілки git, яку буде використано для кожного з модулів на основі поточних значень параметрів tag, branch та branch-group.

  • module-set — наказує kdesrc-build вивести назву набору модулів, який містить модуль. Можна використати для створення кешу автоматичного доповнення у zsh.

  • build-system — наказує kdesrc-build виводити назву виявленої системи збирання для модуля. Цим можна скористатися для діагностики проблем автоматичного виявлення системи збирання або при розробці тестів для специфічних систем збирання.

  • Будь-яка назва параметра, яка є коректною для модулів у файлі налаштувань.

Наприклад, команда kdesrc-build --query branch kactivities kdepim призведе до виведення даних, подібних до цих:

kactivities: master
kdepim: master
--dependency-tree

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

--dependency-tree-fullpath

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

--list-installed

Вивести список встановлених модулів і завершити роботу. Цим можна скористатися для створення даних автоматичного доповнення для параметра --run.

Виключення певної дії

--no-metadata (або -M)

Не отримувати автоматично додаткових метаданих для модулів git KDE. Оновлення самого коду модулів все одно відбуватиметься, якщо ви не додасте параметр --no-src.

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

--no-src (або -S)

Пропустити зв’язок з сервером Git.

--no-build

Пропустити процес збирання.

--no-install

Не встановлювати автоматично пакунки після збирання.

Лише певна дія

--metadata-only

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

--src-only (або -s)

Виконати лише оновлення початкових кодів.

--build-only

Виконати лише процес збирання.

--install-only

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

--build-system-only

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

Поведінка під час збирання

--build-when-unchanged (або --force-build), --no-build-when-unchanged (або --no-force-build)

За допомогою цього параметра можна явним чином вимкнути пропуски у процесі збирання (оптимізацію, якою керує build-when-unchanged параметр). Параметр буде корисним для запуску збирання за допомогою kdesrc-build у разі внесення вами змін, які не може бути автоматично виявлено kdesrc-build. Типово увімкнено.

--refresh-build (або -r)

Повторно створити систему збирання і виконати збирання з початку.

--reconfigure

Виконати cmake (для модулів KDE) або configure (для Qt™) знову, без спорожнення каталогу збирання. Зазвичай, потреби у такій поведінці немає, оскільки kdesrc-build сам може виявити зміни у відповідних параметрах і автоматично перезапустити налаштування збирання. Цей параметр буде використано, якщо ви скористаєтеся параметром --refresh-build.

--install-dir шлях

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

--generate-vscode-project-config, --no-generate-vscode-project-config

Створити каталог .vscode із налаштуваннями для збирання та діагностики у Visual Studio Code. Типово вимкнено.

Під час виконання скрипту

--async, --no-async

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

--color (або --colorful-output), --no-color (або --no-colorful-output)

Вмикає або вимикає виведення інформації у кольорі. Типово увімкнено для інтерактивних терміналів.

--nice (або --niceness) значення

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

--rc-file файл

Файл, з якого слід читати параметри налаштування. Типовим значенням цього параметра є kdesrc-buildrc (скрипт шукатиме його у поточному робочому каталозі). Якщо цього файла не існуватиме, замість нього буде використано ~/.config/kdesrc-buildrc ($XDG_CONFIG_HOME/kdesrc-buildrc, якщо встановлено значення $XDG_CONFIG_HOME). Див. також Розділ 4, Налаштування kdesrc-build.

Налаштовування

--initial-setup

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

Це зокрема:

  • Встановлення відомих залежностей (для підтримуваних дистрибутивів Linux®)

  • Додавання потрібних змінних середовища до ~/.bashrc

Цей параметр є точним відповідником спільного використання параметрів --install-distro-packages --generate-config. У kdesrc-build (реалізація на perl) додатково використовується «--install-distro-packages-perl».

--install-distro-packages

Встановити пакунки дистрибутива (для підтримуваних дистрибутивів Linux®), які потрібні для приготування системи до роботи з kdesrc-build та забезпечення можливості запуску нововстановленого програмного забезпечення KDE.

Див. також --initial-setup

--generate-config

Створити файл налаштувань kdesrc-build.

Див. також --initial-setup

Рівень подробиць

--debug

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

--quiet (або --quite, або -q)

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

--really-quiet

Повідомляти лише про попередження і помилки.

--verbose

Виводити докладну інформацію про те, що відбувається, і про дії, які виконує kdesrc-build.

Відомості щодо скрипту

--version (або -v)

Показує версію програми.

--help (або -h)

Показати лише короткі довідкові відомості про скрипт.

--show-info

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

--show-options-specifiers

Вивести рядки специфікаторів (у форматі, який приймає GetOpts::Long) для усіх параметрів командного рядка, підтримку яких передбачено у скрипті. Цим параметром можуть скористатися розробники, наприклад, для створення функцій автоматичного доповнення у zsh.