[bluez/bluez] b41763: doc: test-runner: document the virtual machine arc...

[Luiz Augusto von Dentz <noreply@github.com>]

  Branch: refs/heads/master
  Home:   https://github.com/bluez/bluez
  Commit: b4176324909d4663c295aef92a446fe403caacd1
      https://github.com/bluez/bluez/commit/b4176324909d4663c295aef92a446fe403caacd1
  Author: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
  Date:   2026-09-14 (Mon, 14 Sep 2026)

  Changed paths:
    M doc/test-runner.rst

  Log Message:
  -----------
  doc: test-runner: document the virtual machine architecture

Add an ARCHITECTURE section describing how the virtual machine instance
is created and how it communicates with the launcher.

Document that the tool is both the launcher and the guest init, that
there is no disk image and the launcher root filesystem is shared
read-only over 9p, the TEST* variables passed on the kernel command
line, the sandbox mounts and the writable overlays needed on top of the
read-only root.

Also document the console and controller attachment: the guest console
is /dev/hvc0, and '-u' attaches the given socket as a second virtio
console, /dev/hvc1, on which the N_HCI line discipline is set so the
transport is HCI H:4 to the hci_uart driver. Mention '-o' as the way
additional channels are added, as done by test-functional.

While at it, add the missing '-H' and '-o' entries to OPTIONS.

Assisted-by: opencode:claude-opus-5


  Commit: 6dc064623c575bd1cea3ff0728fdca787fdc8a57
      https://github.com/bluez/bluez/commit/6dc064623c575bd1cea3ff0728fdca787fdc8a57
  Author: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
  Date:   2026-09-14 (Mon, 14 Sep 2026)

  Changed paths:
    M doc/test-functional.rst

  Log Message:
  -----------
  doc: test-functional: document the test environment architecture

Add an ARCHITECTURE section describing the split between the Pytest
upper tester, which runs on the developer machine and drives the test,
and the VM hosts started via test-runner, which run the BlueZ and kernel
instances under test.

Document the control, log, tty and shared channels set up on top of
test-runner and how they relate to the existing options, and the btvirt
and USB controller topologies. Details of the virtual machine setup
itself are left to test-runner, and writing VM-side test code to the
pytest-bluezenv documentation.

Also fix the temporary directory paths, which are named after
pytest-bluezenv rather than bluez-func-test.

Assisted-by: opencode:claude-opus-5


Compare: https://github.com/bluez/bluez/compare/c8e2b951b07f...6dc064623c57

To unsubscribe from these emails, change your notification settings at https://github.com/bluez/bluez/settings/notifications