Provided by: libguestfs0_1.40.2-2ubuntu6_amd64 bug

НАЗВА

       guestfs-hacking — розширення можливостей і участь у розробці libguestfs

ОПИС

       Цю сторінку підручника призначено для тих, хто хоче розширити можливості libguestfs
       власноруч.

ПОЧАТКОВИЙ КОД

       Код libguestfs зберігається у сховищі github https://github.com/libguestfs/libguestfs

       Велика частина стереотипного коду у libguestfs (RPC, прив'язки, документація) створюється
       автоматично. Це означає, що у звичайному клоні сховища git не буде багатьох файлів, які є
       у архівах з початковим кодом. Вам доведеться запустити генератор ("./autogen.sh && make -C
       generator"), щоб створити ці файли.

       У libguestfs використовується система збирання на основі autotools, основними файлами якої
       є configure.ac і Makefile.am. Див. "СИСТЕМА ЗБИРАННЯ".

       У підкаталозі generator міститься генератор та файли із описом програмного інтерфейсу. У
       підкаталозі lib міститься початковий код бібліотеки. У підкаталогах appliance та daemon
       зберігається початковий код, який збирає базову систему, так код, який запускає базову
       систему, відповідно. Інші каталоги описано у розділі "ПІДКАТАЛОГИ ПОЧАТКОВОГО КОДУ" нижче.

       Окрім того факту, що усі вхідні точки програмного інтерфейсу перебувають у певному
       створеному коді, сама бібліотека є простою. (Фактично, навіть створений код читається так
       самою легко, як і звичайний код.) Деякі дії виконуються суто у бібліотеці, їхній код
       написано мовою C, він зберігається у підкаталозі lib. Виконання інших дій
       переспрямовується до фонової служби, де (після певного скерування RPC) їх реалізовано як
       функції мовою C у файлах підкаталогу daemon.

       Настанови щодо збирання з початкового коду наведено у підручнику guestfs-building(1).

   ПІДКАТАЛОГИ ПОЧАТКОВОГО КОДУ
       У ієрархії початкового коду багато підкаталогів! На яких слід зосередити увагу передусім?
       На каталогах lib та daemon, у яких міститься початковий код основи бібліотеки. generator
       містить код генератора, описаного вище, тому цей підкаталог також є важливим. Файл
       Makefile.am у кореневому каталозі містить цінні дані щодо порядку збирання коду у
       підкаталогах. І нарешті, якщо ви шукаєте код певного інструмента (наприклад v2v) або
       прив'язки до мови (наприклад python), зверніться безпосередньо до відповідного
       підкаталогу, але пам'ятайте, що якщо ще не було запущено генератор, вам може здатися, що у
       початковому коді не вистачає багатьох файлів.

       align
           Програма virt-alignment-scan(1) та документація до неї.

       appliance
           Базова система libguestfs, скрипти збирання тощо.

       bash
           Скрипти доповнення команд у відповідь на натискання клавіші Tab.

       build-aux
           Різноманітні скрипти збирання, які використовуються autotools.

       builder
           Програма virt-builder(1) та документація до неї.

       cat Код програм virt-cat(1), virt-filesystems(1), virt-log(1), virt-ls(1) and virt-tail(1)
           та документація до них.

       common
           У підкаталозі common зберігаються різноманітні бібліотеки внутрішнього коду:

           common/edit
               Загальний код для інтерактивного та неінтерактивного редагування файлів у файловій
               системі libguestfs.

           common/errnostring
               Протоколом обміну даними, який використовується між бібліотекою і фоновою службою,
               запущеною у базовій системі, передбачено кодування номерів помилок у рядки, які
               обробляються цією бібліотекою.

           common/miniexpect
               Копія бібліотеки miniexpect з http://git.annexia.org/?p=miniexpect.git;a=summary.
               Використовується у virt-p2v.

           common/mlaugeas
               Прив'язки до бібліотеки Augeas. Їх запозичено з бібліотеки ocaml-augeas,
               http://git.annexia.org/?p=ocaml-augeas.git

           common/mlgettext
               Невеличкий автоматично створений скрипт-обгортка, який надає змогу збирати
               libguestfs з ocaml-gettext та без нього. Скрипт створюється за допомогою
               ./configure.

           common/mlpcre
               Невибагливі до ресурсів прив'язки до OCaml бібліотеки сумісних із Perl формальних
               виразів (PCRE). Зауважте, що цей код ніяким чином не пов'язано із бібліотекою
               ocaml-pcre, яку створив Markus Mottl.

           common/mlprogress
               Прив'язки OCaml до функцій смужки поступу (див. common/progress).

           common/mlstdutils
               Бібліотека допоміжних функцій, які використовуються у багатьох місцях, суто мовою
               OCaml.

           common/mltools
               Допоміжні функції OCaml, які використовуються лише інструментами віртуалізації
               мовою OCaml (зокрема "virt-sysprep", "virt-v2v" тощо)

           common/mlutils
               Прив'язки до OCaml для функцій C у "common/utils" та деякі прив'язки POSIX, яких
               немає у стандартній бібліотеці OCaml.

           common/mlvisit
               Прив'язки до OCaml для функцій visit (див. common/visit).

           common/mlxml
               Прив'язки OCaml для бібліотеки libxml2.

           common/options
               Загальна обробка параметрів для guestfish, guestmount та деяких інструментів
               віртуалізації.

           common/parallel
               Комплект бібліотек для паралельної обробки декількох доменів libvirt.

           common/progress
               Загальний код для виведення смужок поступу.

           common/protocol
               Тут визначається протокол обміну даними, заснований на XDR, який використовується
               для спілкування між бібліотекою і фоновою службою у базовій системі.

           common/qemuopts
               Мінібібліотека для запису рядків команд qemu та файлів налаштувань qemu.

           common/structs
               Загальний код для виведення та вивільнення структур libguestfs, який
               використовується у бібліотеці та деяких інструментах.

           common/utils
               Різноманітні допоміжні функції, які використовуються у бібліотеці та інструментах.

           common/visit
               Рекурсивний обхід ієрархії файлових систем guestfs.

           common/windows
               Допоміжні функції для обробки літер дисків у Windows.

       contrib
           Зовнішні внески, експериментальні частини.

       customize
           Програма virt-customize(1) та документація до неї.

       daemon
           Фонова служба, яка працює у базовій системі libguestfs і забезпечує виконання дій.

       df  Програма virt-df(1) та документація до неї.

       dib Програма virt-dib(1) та документація до неї.

       diff
           Програма virt-diff(1) та документація до неї.

       docs
           Різноманітні сторінки підручника.

       edit
           Програма virt-edit(1) та документація до неї.

       examples
           Код прикладів використання програмного інтерфейсу мовою C.

       fish
           guestfish(1) — оболонка командного рядка та різноманітні скрипти оболонки на її
           основі, зокрема virt-copy-in(1), virt-copy-out(1), virt-tar-in(1), virt-tar-out(1).

       format
           Програма virt-format(1) та документація до неї.

       fuse
           guestmount(1), FUSE (файлова система у просторі користувача), яку зібрано на основі
           libguestfs.

       generator
           Критично важливий засіб створення коду, використовується для автоматичного створення
           значного обсягу важливого коду мовою C, зокрема для RPC та прив'язок.

       get-kernel
           Програма virt-get-kernel(1) та документація до неї.

       gnulib
           Gnulib використовується як бібліотека забезпечення портованості. До цього каталогу
           включено копію gnulib.

       inspector
           virt-inspector(1) — засіб інспектування образів віртуальних машин.

       lib Початковий код бібліотеки мовою C.

       logo
           Логотип, який використовується на сайті. До речі, ім'я рибки — Артур.

       m4  Макроси M4, які використовуються autoconf. Див. "СИСТЕМА ЗБИРАННЯ".

       make-fs
           Програма virt-make-fs(1) та документація до неї.

       p2v Програма virt-p2v(1), документація та скрипти для збирання ISO або образу диска
           virt-p2v.

       po  Переклади простих рядків gettext.

       po-docs
           Інфраструктура збирання та файли PO перекладів сторінок підручника та файлів POD.
           Колись ми об'єднаємо ці дані з каталогом po, але цей процес є доволі складним.

       rescue
           Програма virt-rescue(1) та документація до неї.

       resize
           Програма virt-resize(1) та документація до неї.

       sparsify
           Програма virt-sparsify(1) та документація до неї.

       sysprep
           Програма virt-sysprep(1) та документація до неї.

       tests
           Тести.

       test-data
           Файли та інші тестові дані, які використовуються при тестуванні.

       test-tool
           Засіб тестування, який допоможе визначити кінцевим користувачам, чи працюватиме їхня
           комбінація qemu/ядро з libguestfs.

       tmp Використовується для тимчасових файлів під час тестування (замість /tmp та подібних
           каталогів). Причиною створення є уможливлення запуску декількох тестів libguestfs
           паралельно без ризику перезапису базової системи набором тестів, який виконується
           паралельно із набором, за допомогою якого було створено базову систему.

       tools
           Засоби командного рядка, які написано мовою програмування Perl (virt-win-reg(1) та
           багато інших).

       utils
           Різноманітні допоміжні програми, зокрема "boot-benchmark".

       v2v Програма virt-v2v(1) та документація до неї.

       website
           Файли сайта http://libguestfs.org.

       csharp
       erlang
       gobject
       golang
       haskell
       java
       lua
       ocaml
       php
       perl
       python
       ruby
           Прив’язки до мов програмування.

   СИСТЕМА ЗБИРАННЯ
       Libguestfs використовує систему збирання GNU autotools (autoconf, automake, libtool).

       Скрипт ./configure створюється на основі configure.ac і m4/guestfs-*.m4. Більшу частину
       вмісту скрипту configure складають дані з багатьох файлів макросів m4, поділених за
       розділами, наприклад, m4/guestfs-daemon.m4 призначено для обробки залежностей фонової
       служби (daemon).

       Завданням файла Makefile.am на верхньому рівні є визначення списку підкаталогів
       ("SUBDIRS") у порядку їхнього збирання.

       common-rules.mk включається до усіх файлів Makefile.am (верхнього рівня та підкаталогів).
       subdir-rules.mk включається лише до файлів Makefile.am у підкаталогах.

       Цілей збирання багато. Скористайтеся цією командою, щоб побачити список:

        make help

РОЗШИРЕННЯ МОЖЛИВОСТЕЙ LIBGUESTFS

   ДОДАВАННЯ НОВИХ ПРОГРАМНИХ ІНТЕРФЕЙСІВ
       Оскільки більша частина стереотипного коду у libguestfs створюється у автоматичному
       режимі, розширити програмний інтерфейс libguestfs доволі просто.

       Щоб додати нову дію програмного інтерфейсу, слід внести дві зміни:

       1.  Вам слід додати опис виклику (назву, параметри, тип значення, яке повертається, тести,
           документацію) до generator/actions_*.ml і, можливо, до generator/proc_nr.ml.

           Існує два різновиди дій програмного інтерфейсу. Тип залежить від того, проходить
           виклик до базової системи через фонову службу, чи обслуговується лише засобами
           бібліотеки (див. "АРХІТЕКТУРА" in guestfs-internals(1)). "guestfs_sync" in guestfs(3)
           є прикладом дій першого типу, оскільки синхронізація відбувається у базовій системі.
           "guestfs_set_trace" in guestfs(3) є прикладом дій другого типу, оскільки прапорець
           трасування обслуговується у дескрипторі, а усе трасування виконується на боці
           бібліотеки.

           Більшість нових дій належить до першого типу, тому їхні записи додаються до списку
           "daemon_functions". У кожної функції є унікальний номер процедури, який
           використовується у протоколі RPC, який пов'язується із цією дією під час оприлюднення
           версії libguestfs і який не можна використовувати повторно. Знайдіть останній номер
           процедури і додайте до нього одиницю, щоб отримати ваш номер.

           Дії другого типу, які пов'язано лише з бібліотекою, слід додавати до списку
           "non_daemon_functions". Оскільки ці функції обслуговуються бібліотекою і не
           поширюються механізмом RPC до фонової служби, ці функції не потребують номеру
           процедури; отже, для них встановлюється номер процедури "-1".

       2.  Реалізація дії (мовою C):

           Для дій фонової служби слід реалізувати функцію "do_<назва>" у каталозі "daemon/".

           Для дій бібліотеки слід реалізувати функцію "guestfs_impl_<назва>" у каталозі "lib/".

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

       3.  Альтернатива кроку 2: починаючи з версії libguestfs 1.38, дії фонової служби може бути
           реалізовано мовою OCaml. Вам слід встановити прапорець "impl = OCaml ..." у
           генераторі. Прикладом може слугувати файл daemon/file.ml.

       Після внесення цих змін скористайтеся командою "make" для збирання.

       Зауважте, що вам не потрібно реалізовувати RPC, прив'язки до мов, сторінки підручника або
       щось інше. Усе це буде створено автоматично на основі опису OCaml.

       Додавання тестів для програмного інтерфейсу

       До кожного виклику програмного інтерфейсу можна не додавати тести або додавати будь-яку
       кількість тестів. Тести може бути додано або як частину опису програмного інтерфейсу
       (generator/actions_*.ml), або у деяких рідкісних випадках, додати скрипт до "tests/*/".
       Зауважте, що додавання скрипту до "tests/*/" уповільнює тестування, тому, якщо можна,
       користуйтеся першим зі способів.

       Нижче описано тестове середовище, яке використовується при додавання тесту програмного
       інтерфейсу до actions_*.ml.

       У середовищі тестування 4 блокових пристрої:

       /dev/sda 2 ГБ
           Блоковий пристрій загального типу для тестування.

       /dev/sdb 2 ГБ
           /dev/sdb1 — файлова система ext2, яка використовується для тестування дій із запису до
           файлової системи.

       /dev/sdc 10 МБ
           Використовується для тестів, у яких потрібні два блокових пристрої.

       /dev/sdd
           ISO із фіксованим вмістом (див. images/test.iso).

       Щоб мати змогу виконувати тестування у прийнятні строки, базову систему та блокові
       пристрої libguestfs слід повторно використовувати у тестах. Отже, не намагайтеся тестувати
       "guestfs_kill_subprocess" in guestfs(3) :-x

       Кожен тест запускає початковий сценарій, який вибирається за допомогою одного з виразів
       "Init*", описаний у generator/types.ml. Сценарій ініціалізує диски, згадані вище, у
       спосіб, який задокументовано у types.ml. Ви не повинні робити у своєму коді жодних
       припущень щодо попереднього вмісту інших дисків, які не ініціалізовано.

       Ви можете додати інструкцію щодо попередніх вимог до будь-якого окремого тесту. Це
       динамічна перевірка, яка, якщо її не буде пройдено, призведе до пропускання тесту. Це
       корисно для тестування команди, яка може не працювати у всіх різновидах збірок libguestfs.
       Тест, для якого попередньою вимогою є "Always", запускається безумовно.

       Крім того, пакувальники можуть пропускати окремі тести встановленням відповідних змінних
       середовища до запуску "make check".

        SKIP_TEST_<CMD>_<NUM>=1

       Приклад: "SKIP_TEST_COMMAND_3=1" призведе до пропускання тесту 3 у "guestfs_command" in
       guestfs(3).

       або:

        SKIP_TEST_<CMD>=1

       Приклад: "SKIP_TEST_ZEROFREE=1" призводить до пропускання усіх тестів "guestfs_zerofree"
       in guestfs(3).

       Пакувальники можуть обмежити тестування певним набором тестів, встановлюючи, наприклад,
       таке:

        TEST_ONLY="vfs_type zerofree"

       Див. tests/c-api/tests.c, щоб дізнатися більше про те, як працюють ці змінні середовища.

       Діагностика нових програмних інтерфейсів

       Перевірте нові можливості, перш ніж записувати їх до сховища коду.

       Для перевірки нових команд ви можете скористатися guestfish.

       Діагностика фонової служби є проблематичною, оскільки вона виконується у мінімалістичному
       середовищі. Втім, ви можете скористатися виведенням повідомлень за допомогою fprintf у
       фоновій службі до stderr. Повідомлення можна буде переглядати за допомогою "guestfish -v".

   ДОДАВАННЯ НОВОЇ ПРИВ’ЯЗКИ ДО МОВИ
       Усі прив'язки до мов має бути створено відповідним засобом (див. підкаталог generator).

       Документації з цього питання ще не написано. Пропонуємо вам звернутися до коду наявних
       прив'язок, наприклад generator/ocaml.ml або generator/perl.ml.

       Додавання тестів для прив'язок до мов

       Прив'язки до мов мають постачатися із тестами. Раніше тестування прив'язок до мов було
       суто ситуативним, але тепер ми намагаємося формалізувати набір тестів, які має
       використовувати кожна прив'язка до мови.

       У поточній версії повний набір тестів реалізовано лише для прив'язок до OCaml і Perl.
       Канонічним набором є набір для OCaml, тому вам слід емулювати тести саме для OCaml.

       Ось схема нумерації, яка використовується у тестах:

        - 000+, базові перевірки:

          010  завантажити бібліотеку
          020  створення
          030  прапорці створення
          040  створення декількох дескрипторів
          050  налаштовування тестування та отримання властивостей налаштовування
          060  явне закриття
          065  неявне закриття (у мовах із збирачем сміття)
          070  аргументи параметрів
          080  версія
          090  повернуті значення

        - 100  запуск, створення розділів та логічних томів, а також файлових систем

        - події 400+:

          410  подія закриття
          420  повідомлення журналу
          430  повідомлення щодо поступу

        - 800+ тести на регресії (специфічні для мови)

        - 900+ будь-які інші нетипові тести для мови

       Для заощадження часу під час виконання тестування дескриптор запускатимуть лише 100, 430,
       800+, 900+.

   ФОРМАТУВАННЯ КОДУ
       Наш початковий код мовою C загалом відповідає деяким базовим вимогам щодо форматування
       коду. Наявна кодова база є повністю однорідною у цьому сенсі, але ми б хотіли, щоб увесь
       новий код також було форматовано подібним чином. Якщо коротко, користуйтеся пробілами, а
       не символами табуляції, використовуйте додаткові 2 пробіли на кожному із рівнів відступів,
       у інших аспектах форматування слідуйте стилю книги Кернігана та Річі.

       If you use Emacs, add the following to one of your start-up files (e.g., ~/.emacs), to
       help ensure that you get indentation right:

        ;;; In libguestfs, indent with spaces everywhere (not TABs).
        ;;; Exceptions: Makefile and ChangeLog modes.
        (add-hook 'find-file-hook
            '(lambda () (if (and buffer-file-name
                                 (string-match "/libguestfs\\>"
                                     (buffer-file-name))
                                 (not (string-equal mode-name "Change Log"))
                                 (not (string-equal mode-name "Makefile")))
                            (setq indent-tabs-mode nil))))

        ;;; Під час редагування початкового коду C у libguestfs користуйтеся цим стилем.
        (defun libguestfs-c-mode ()
          "C mode with adjusted defaults for use with libguestfs."
          (interactive)
          (c-set-style "K&R")
          (setq c-indent-level 2)
          (setq c-basic-offset 2))
        (add-hook 'c-mode-hook
                  '(lambda () (if (string-match "/libguestfs\\>"
                                      (buffer-file-name))
                                  (libguestfs-c-mode))))

   ТЕСТУВАННЯ ВНЕСЕНИХ ВАМИ ЗМІН
       Перетворити попередження на повідомлення про помилки під час розробки, щоб ці попередження
       не ігнорувалися:

        ./configure --enable-werror

       Корисні цілі збирання:

       "make check"
           Запускає звичайний комплект перевірок.

           Реалізовано за допомогою типової цілі automake "TESTS". Докладніше про цю ціль можна
           дізнатися з документації до automake.

       "make check-valgrind"
           Запускає підмножину комплекту тестування у valgrind.

           Див. "VALGRIND" нижче.

       "make check-valgrind-local-guests"
           Запускає підмножину комплекту тестування у valgrind з використанням локально
           встановлених гостьових систем libvirt (лише для читання).

       "make check-direct"
           Виконує усі тести за допомогою типового модуля роботи із базовою системою. Працює,
           лише якщо за допомогою "./configure --with-default-backend=..." було вибрано нетиповий
           модуль.

       "make check-valgrind-direct"
           Запустити підмножину комплексу тестів під керуванням valgrind з використанням типового
           модуля базової системи.

       "make check-uml"
           Виконує усі тести з використанням модуля режиму користувача у Linux.

           Оскільки немає стандартизованого місця для зберігання ядра Linux з режимом
           користувача, вам слід встановити значення "LIBGUESTFS_HV" таким чином, щоб воно
           вказувало на образ ядра. Приклад:

            make check-uml LIBGUESTFS_HV=~/d/linux-um/vmlinux

       "make check-valgrind-uml"
           Виконує усі тести з використанням модуля режиму користувача Linux під керуванням
           valgrind.

           Як і вище, вам слід встановити значення "LIBGUESTFS_HV" так, щоб воно вказувало на
           ядро.

       "make check-with-upstream-qemu"
           Виконує усі тести з використанням локального виконуваного файла qemu. Шукає
           виконуваний файл qemu за допомогою змінної QEMUDIR (типове значення $HOME/d/qemu), але
           ви можете встановити інший каталог за допомогою рядка команди. Приклад:

            make check-with-upstream-qemu QEMUDIR=/usr/src/qemu

       "make check-with-upstream-libvirt"
           Виконує усі тести за допомогою локальної копії libvirt. Працює, лише якщо за допомогою
           "./configure --with-default-backend=libvirt" було вибрано модуль libvirt.

           Пошук libvirt виконуватиметься у каталозі LIBVIRTDIR (типово, $HOME/d/libvirt), але ви
           можете вказати інший каталог у рядку команди. Приклад:

            make check-with-upstream-libvirt LIBVIRTDIR=/usr/src/libvirt

       "make check-slow"
           Запускає повільні тести або тести, які виконуються довго. Такі тести типово не
           запускаються.

           Щоб позначити тест як повільний або такий, який виконується довго:

           ·   Додайте це до списку "TESTS" у Makefile.am, подібно до звичайного тесту.

           ·   Змініть тест так, щоб у ньому перевірялася умова для змінної середовища "SLOW=1",
               і якщо таке значення змінної не встановлено, тест пропускався (тобто повертав код
               виходу 77). Якщо використовується $TEST_FUNCTIONS, для цього ви можете викликати
               функцію "slow_test".

           ·   Додайте змінну "SLOW_TESTS" до файла Makefile.am зі значенням-списком повільних
               тестів.

           ·   Додайте таке правило до Makefile.am:

                check-slow:
                  $(MAKE) check TESTS="$(SLOW_TESTS)" SLOW=1

       "sudo make check-root"
           Запускає деякі тести, які потребують прав доступу користувача root. Ці тести, як ми
           припускаємо, безпечні, але вам слід вжити усіх додаткових засобів захисту. Вам слід
           запускати цю команду від імені root (наприклад, за допомогою явного використання
           sudo(8)).

           Щоб позначити тест як такий, що вимагає прав доступу користувача root:

           ·   Додайте це до списку "TESTS" у Makefile.am, подібно до звичайного тесту.

           ·   Внесіть зміни до тесту так, щоб тест перевіряв, чи euid == 0, і якщо це значення
               не встановлено, тест пропускається (тобто повертає код виходу 77). Якщо
               використовується $TEST_FUNCTIONS, ви можете викликати функцію "root_test" для
               цього.

           ·   Додайте змінну "ROOT_TESTS" до файла Makefile.am зі значенням-списком тестів для
               root.

           ·   Додайте таке правило до Makefile.am:

                check-root:
                  $(MAKE) check TESTS="$(ROOT_TESTS)"

       "make check-all"
           Еквівалент запуску усіх правил "make check*", окрім "check-root".

       "make check-release"
           Виконує підмножину правил "make check*", які слід передати до створення архіву tar. У
           поточній версії це:

           ·   check

           ·   check-valgrind

           ·   check-direct

           ·   check-valgrind-direct

           ·   check-slow

       "make installcheck"
           Запустити "make check" для встановленої копії libguestfs.

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

           Команди:

            ./autogen.sh
            make clean ||:
            make
            make installcheck

   VALGRIND
       Коли ви віддаєте команду "make check-valgrind", відбувається пошук будь-якого Makefile.am
       у ієрархії коду, де є ціль "check-valgrind:", і його запуск.

       Правильно написати Makefile.am і тести, щоб скористатися valgrind і паралельним
       тестуванням automake, не так уже і просто.

       Якщо ваш тести запускаються за допомогою скриптової обгортки для командної оболонки, у
       обгортці слід скористатися таким кодом:

        $VG virt-foo

       а у Makefile.am слід вказати:

        check-valgrind:
            make VG="@VG@" check

       Втім, якщо ваші виконувані файли запускаються безпосередньо з правила "TESTS", до
       Makefile.am слід внести такий рядок:

        LOG_COMPILER = $(VG)

        check-valgrind:
            make VG="@VG@" check

       Який би з варіантів ви не реалізовували, слід перевіряти, чи ту програму ви тестуєте,
       шляхом уважного вивчення файлів журналу tmp/valgrind*.

   НАДСИЛАННЯ ЛАТОК
       Надсилайте латки до списку листування, http://www.redhat.com/mailman/listinfo/libguestfs і
       копію повідомлення до rjones@redhat.com.

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

   НЕТИПОВІ ЗАСОБИ ФОРМАТУВАННЯ PRINTF У ФОНОВІЙ СЛУЖБІ
       У коді фонової служби напис створено нетипові форматувальники printf %Q і %R, які
       використовуються для режиму встановлення лапок у командній оболонці.

       %Q  Простий рядок командної оболонки із лапками. Автоматичне екранування пробілів та інших
           керівних символів оболонки.

       %R  Те саме, що і %Q, але рядок вважатиметься шляхом із префіксом sysroot.

       Приклад:

        asprintf (&cmd, "cat %R", path);

       дасть "cat /sysroot/якийсь\ шлях\ із\ пробілами"

       Зауваження: не використовуйте ці замінники, якщо передаєте параметри функціям
       "command{,r,v,rv}()". У параметрах цих функцій НЕ потрібно нічого міняти, оскільки вони не
       передаються крізь командну оболонку (а безпосередньо передаються функції exec). Втім,
       ймовірно, варто використовувати функцію "sysroot_path()".

   ПІДТРИМКА ІНТЕРНАЦІОНАЛІЗАЦІЇ (I18N)
       У нашій бібліотеці передбачено можливість інтернаціоналізації (засобами gettext).

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

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

ІНШІ ТЕМИ

   ЯК КОМПІЛЮЮТЬСЯ І КОМПОНУЮТЬСЯ ПРОГРАМИ OCAML
       Більша частина цього розділу присвячена питанню «як ми змусили automake і ocamlopt
       працювати разом», оскільки самі програми OCaml зібрати легко.

       У automake немає вбудованої підтримки програм OCaml, ocamlc та ocamlopt. Наш підхід
       полягає у обробці програм OCaml як програм C, які можуть містити такі «інші об'єкти»
       ("DEPENDENCIES" у термінології automake), які можуть бути об'єктами OCaml. Це працює,
       оскільки програми OCaml зазвичай містять файли C для природних прив'язок до бібліотек
       тощо.

       Отже, типова програма описується як список файлів з її кодом мовою C:

        virt_v2v_SOURCES = ... utils-c.c xml-c.c

       Для програм, які не містять явних початкових текстів мовою C ми створюємо порожній файл
       dummy.c і додаємо його до списку замість справжніх файлів:

        virt_resize_SOURCES = dummy.c

       Об'єкти OCaml, які містять більшу частину коду, потрапляють до списку як залежності
       automake (інші залежності також можуть потрапляти до списку):

        virt_v2v_DEPENDENCIES = ... cmdline.cmx v2v.cmx

       Окрім того, єдиною іншою річчю, яку нам слід зробити, є надання нетипової команди
       компонування. Ця команда потрібна, оскільки інакше automake не зможе зібрати команду
       ocamlopt, список об'єктів та бібліотеки "-cclib" у належному порядку.

        virt_v2v_LINK = \
            $(top_srcdir)/ocaml-link.sh -cclib '-lutils -lgnu' -- ...

       Справжні правила, із якими ви можете ознайомитися у файлі v2v/Makefile.am є дещо
       складнішими за ці, оскільки у них ще треба обробити:

       ·   Компіляцію у байткод або природний код системи.

       ·   Взірцеві правила, потрібні для збирання коду OCaml у об'єкти.

           Ці правила тепер зберігаються у subdir-rules.mk на верхньому рівні ієрархії коду. Цей
           файл включається до усіх підкаталогів Makefile.am.

       ·   Додавання файлів початкового коду OCaml до "EXTRA_DIST".

           Automake не зможе визначити повний список початкових кодів для виконуваного файла,
           тому програма не зможе додати відповідні файли автоматично.

   VIRT-V2V
       Спочатку трохи історії. Протягом свого існування програма virt-v2v зазнала принаймні двох
       повних переписувань, тому поточна версія є принаймні третьою (ми не маємо планів
       переписувати її ще раз). Попередню версію було написано мовою Perl. Її код і досі
       зберігається тут: https://git.fedorahosted.org/git/virt-v2v.git

       Поточну версію було започатковано як майже порядково переписану з Perl на OCaml + C, і
       вона все ще зберігає повністю подібну структуру. Тому, якщо ви не розумієте якихось
       подробиць щодо коду (особливо подробиць щодо перетворення гостьових систем), вам може
       допомогти читання коду мовою Perl.

       Ось файли, з яких варто розпочати читання цього коду:

       ·   types.mli

       ·   v2v.ml

       У types.mli визначаються усі структури, які використовуються і передаються під час обміну
       даними між різними частинами програми. У v2v.ml реалізовано керування роботою програми на
       різних етапах.

       Після вивчення цих файлів ви можете перейти до вивчення модулів вхідних даних (input_*),
       модулів вихідних даних (output_*) або модулів перетворення (convert_*). Модулі вхідних і
       вихідних даних визначають перелік варіантів для параметрів -i та -o (див. підручник).
       Модулі перетворення визначають, із якими типами гостьових систем ми можемо працювати і які
       конкретно кроки слід виконати для їхнього перетворення.

       Усі інші файли у цьому каталозі є певним чином супровідними модулями або бібліотеками.
       Частину коду написано мовою C, особливо там, де ми хотіли використати зовнішні бібліотеки
       C, зокрема libxml2.

   VIRT-P2V
       Virt-p2v є оболонкою над virt-v2v. Інакше кажучи, усе, що робить ця програма, — це працює
       як оболонка із графічним інтерфейсом, для виконання самого перетворення ця програма
       викликає virt-v2v. Тому, більша частина коду мовою C у підкаталозі p2v/ є кодом Gtk
       (графічного інтерфейсу) або супутнім кодом для обміну даними із віддаленим сервером
       перетворення. У virt-v2v немає ніякого спеціальної підтримки фізичних машин. Дані фізичним
       машин перетворюються у той самий спосіб, що і дані сторонніх віртуальних машин.

       Як запустити virt-p2v

       Ви можете запустити виконуваний файл p2v/virt-p2v безпосередньо, але програма спробує
       перетворити справжній диск /dev/sda вашої системи, що навряд чи дасть бажані результати.
       Втім, virt-p2v також має тестовий режим, у якому ви можете вказати тестовий диск:

        make -C p2v run-virt-p2v-directly

       Це обгортка до параметра --test-disk virt-p2v(1). Ви можете керувати диском «фізичної
       машини» встановленням значення "PHYSICAL_MACHINE", яке вказує на образ диска.

       Реалістичнішим тестом є запуск virt-p2v у віртуальній машині на локальній машині. Для
       цього зробіть так:

        make -C p2v run-virt-p2v-in-a-vm

       Ця команда також запускає qemu для диска «фізичної машини» (вказати яку можна за допомогою
       встановлення значення змінної "PHYSICAL_MACHINE"), віртуального компакт-диска та
       різноманітних мережевих карток для тестування. Ви можете змінити виконуваний файл qemu і
       додати параметри команди qemu встановленням значень параметрів "QEMU" і/або "QEMU_OPTIONS"
       у командному рядку make.

       Запущена у третій спосіб програма virt-p2v досить точно імітує програму, що отримується за
       допомогою PXE, а потім виконує автоматичне перетворення початкової фізичної машини (спосіб
       без графічного інтерфейсу — див. наступний розділ нижче):

        make -C p2v run-virt-p2v-non-gui-conversion

       Як розібратися у коді virt-p2v

       Див. також: "ЯК ПРАЦЮЄ VIRT-P2V" in virt-p2v(1)

       Існує два шляхи крізь код, з графічним інтерфейсом або без графічного інтерфейсу (обробка
       командного рядка ядра):

        main.c ──────┬─────▶ gui.c ──────┬─────▶ conversion.c
                     │                   │
                     │                   │
                     └────▶ kernel.c ────┘

       але обидва шляхи виконують зворотний виклик функції "start_conversion" з conversion.c для
       запуску віддаленого virt-v2v.

       Основним завданням gui.c/kernel.c є заповнення параметрів налаштовування virt-v2v
       (config.c).

       Під час перетворення слід встановити з'єднання ssh, і це виконується за допомогою двох
       бібліотек:

        conversion.c ──────▶ ssh.c ──────▶ miniexpect.c

       де ssh.c відповідає за керування з'єднаннями ssh взагалі, а miniexpect.c реалізує
       expect-подібні функціональні можливості для інтерактивного обміну даними із віддаленим
       сервером перетворення virt-v2v.

       (Зауважте, що miniexpect є окремою бібліотекою із власною основною гілкою розробки, отже,
       якщо ви накладаєте латку на miniexpect.c, будь ласка, переконайтеся, що зміни також
       надіслано до основної гілки розробки miniexpect:
       http://git.annexia.org/?p=miniexpect.git;a=summary)

ЗАВДАННЯ ІЗ СУПРОВОДУ

   ЦІЛІ ДЛЯ СУПРОВІДНИКІВ У MAKEFILE
       Ці цілі "make", ймовірно, не працюватимуть або не будуть корисними, якщо ви не є
       супровідником пакунків libguestfs.

       make maintainer-commit

       Ця ціль вносить усі зміни із робочого каталогу до системи керування сховищем коду із
       повідомленням щодо внеску "Version $(VERSION).". Вам слід спочатку оновити configure.ac,
       очистити ієрархію коду та виконати повторне збирання.

       make maintainer-tag

       Ця команда створює мітку для поточного внеску у HEAD зі значенням мітки "v$(VERSION)" і
       одним із таких повідомлень:

        Version $(VERSION) stable

        Version $(VERSION) development

       (Опис відмінностей між стабільним випуском і випуском, який перебуває у розробці, наведено
       у розділі "НУМЕРАЦІЯ ВЕРСІЙ LIBGUESTFS" in guestfs(3).)

       make maintainer-check-authors

       Перевірити, чи усіх авторів (записи яких можна знайти у повідомленнях щодо внесків до git)
       включено до файла generator/authors.ml.

       make maintainer-check-extra-dist

       Це правило слід запускати після "make dist" (щоб у робочому каталозі уже був архів tar).
       Воно порівнює вміст архіву tar із даними у git з метою переконатися, що не пропущено
       жодного файла із правил "EXTRA_DIST" у Makefile.am.

       make maintainer-upload-website

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

   СТВОРЕННЯ СТАБІЛЬНОГО ВИПУСКУ
       Тут наведено документацію щодо створення стабільних випусків. Загальні правила щодо
       створення стабільних випусків наведено у розділі "НУМЕРАЦІЯ ВЕРСІЙ LIBGUESTFS" in
       guestfs(3).

       ·   Перевірте, чи працює "make && make check" принаймні у таких системах:

           Fedora (x86-64)
           Debian (x86-64)
           Ubuntu (x86-64)
           Fedora (aarch64)
           Fedora (ppc64)
           Fedora (ppc64le)
       ·   Перевірте, чи працює "./configure --without-libvirt".

       ·   Внесіть завершальні зміни до guestfs-release-notes.pod

       ·   Надіслати і отримати дані з Zanata.

           Віддайте команду:

            zanata push

           щоб надіслати найсвіжіші файли POT на Zanata. Потім віддайте команду:

            ./zanata-pull.sh

           яка є обгорткою для команд отримання найсвіжіших перекладених файлів *.po.

       ·   Оновіть gnulib до найсвіжішої версії основної гілки розробки.

       ·   Створіть каталоги стабільної версії і версії у розробці на
           http://libguestfs.org/download.

       ·   Внесіть зміни до website/index.html.in.

       ·   Встановіть версію (у configure.ac) у значення нової стабільної версії, тобто 1.XX.0, і
           запишіть версію:

            ./localconfigure
            make distclean -k
            ./localconfigure
            make && make dist
            make maintainer-commit
            make maintainer-tag

       ·   Створіть стабільну гілку у git:

            git branch stable-1.XX
            git push origin stable-1.XX

       ·   Виконайте повноцінний випуск стабільної гілки.

       ·   Встановіть значення номера наступної версії для розробки і запишіть його до сховища.
           Можна також створити повноцінний випуск із гілки для розробки.

ВНУТРІШНЯ ДОКУМЕНТАЦІЯ

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

       Цей розділ створено автоматично на основі тих коментарів "/**" у файлах початкового коду,
       які форматовано для використання у форматі POD.

       Ці функції не експортуються відкрито (public). Їх може бути змінено або вилучено у
       будь-якій новішій версії.

       __INTERNAL_DOCUMENTATION__

ТАКОЖ ПЕРЕГЛЯНЬТЕ

       guestfs(3), guestfs-building(1), guestfs-examples(3), guestfs-internals(1),
       guestfs-performance(1), guestfs-release-notes(1), guestfs-testing(1),
       libguestfs-test-tool(1), libguestfs-make-fixed-appliance(1), http://libguestfs.org/.

АВТОРИ

       Richard W.M. Jones ("rjones at redhat dot com")

АВТОРСЬКІ ПРАВА

       Copyright (C) 2009-2019 Red Hat Inc.

LICENSE

BUGS

       To get a list of bugs against libguestfs, use this link:
       https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools

       To report a new bug against libguestfs, use this link:
       https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools

       When reporting a bug, please supply:

       ·   The version of libguestfs.

       ·   Where you got libguestfs (eg. which Linux distro, compiled from source, etc)

       ·   Describe the bug accurately and give a way to reproduce it.

       ·   Run libguestfs-test-tool(1) and paste the complete, unedited output into the bug
           report.