* [PATCH BlueZ] doc/test-runner: Update documentation using rst format
@ 2023-08-14 19:15 Luiz Augusto von Dentz
2023-08-14 20:34 ` [BlueZ] " bluez.test.bot
0 siblings, 1 reply; 2+ messages in thread
From: Luiz Augusto von Dentz @ 2023-08-14 19:15 UTC (permalink / raw)
To: linux-bluetooth
From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
This updates test-runner documentation with a few examples using rst
format.
---
doc/test-runner.rst | 175 ++++++++++++++++++++++++++++++++++++
doc/test-runner.txt | 85 ------------------
tools/test-runner.rst | 200 ------------------------------------------
3 files changed, 175 insertions(+), 285 deletions(-)
create mode 100644 doc/test-runner.rst
delete mode 100644 doc/test-runner.txt
delete mode 100644 tools/test-runner.rst
diff --git a/doc/test-runner.rst b/doc/test-runner.rst
new file mode 100644
index 000000000000..1566487fe4d0
--- /dev/null
+++ b/doc/test-runner.rst
@@ -0,0 +1,175 @@
+===========
+test-runner
+===========
+
+**test-runner** [*OPTIONS*] -- <test-name>
+
+DESCRIPTION
+===========
+
+**test-runner(1)** is used to test Kernel changes to the Bluetooth subsystem,
+it lunches a virtual machine using the local filesystem.
+
+OPTIONS
+=======
+
+:-a:--auto: Find tests and run them
+:-b/--dbus: Start D-Bus system daemon
+:-s/--dbus-session: Start D-Bus session daemon
+:-d/--daemon: Start bluetoothd
+:-m/--monitor: Start btmon
+:-l/--emulator: Start btvirt
+:-A/-audio[=path]: Start audio server
+:-u/--unix[=path]: Provide serial device
+:-q/--qemu=<path>: QEMU binary
+:-k/--kernel=<image>: Kernel image (bzImage)
+:-h/--help: Show help options
+
+Kernel
+======
+
+The test-runner tool requires a kernel that is at least build with these
+minimal options for a successful boot. These options should be installed as
+.config in the kernel source directory followed by:
+
+.. code-block::
+
+ make olddefconfig
+
+After that a default kernel with the required options can be built. More
+option (like the Bluetooth subsystem) can be enabled on top of this.
+
+.. code-block::
+
+ CONFIG_VIRTIO=y
+ CONFIG_VIRTIO_PCI=y
+
+ CONFIG_NET=y
+ CONFIG_INET=y
+
+ CONFIG_NET_9P=y
+ CONFIG_NET_9P_VIRTIO=y
+
+ CONFIG_9P_FS=y
+ CONFIG_9P_FS_POSIX_ACL=y
+
+ CONFIG_SERIAL_8250=y
+ CONFIG_SERIAL_8250_CONSOLE=y
+ CONFIG_SERIAL_8250_PCI=y
+ CONFIG_SERIAL_8250_NR_UARTS=4
+
+ CONFIG_TMPFS=y
+ CONFIG_TMPFS_POSIX_ACL=y
+ CONFIG_TMPFS_XATTR=y
+
+ CONFIG_DEVTMPFS=y
+ CONFIG_DEBUG_FS=y
+
+Bluetooth
+---------
+
+.. code-block::
+
+ CONFIG_BT=y
+ CONFIG_BT_BREDR=y
+ CONFIG_BT_RFCOMM=y
+ CONFIG_BT_BNEP=y
+ CONFIG_BT_HIDP=y
+ CONFIG_BT_LE=y
+
+ CONFIG_BT_HCIUART=y
+ CONFIG_BT_HCIUART_H4=y
+ CONFIG_BT_HCIVHCI=y
+
+ CONFIG_CRYPTO_CMAC=y
+ CONFIG_CRYPTO_USER_API=y
+ CONFIG_CRYPTO_USER_API_HASH=y
+ CONFIG_CRYPTO_USER_API_SKCIPHER=y
+
+ CONFIG_UNIX=y
+
+ CONFIG_UHID=y
+
+Lock debuging
+-------------
+
+To catch locking related issues the following set of kernel config
+options may be useful:
+
+.. code-block::
+
+ CONFIG_DEBUG_KERNEL=y
+ CONFIG_LOCKDEP_SUPPORT=y
+ CONFIG_DEBUG_SPINLOCK=y
+ CONFIG_DEBUG_LOCK_ALLOC=y
+ CONFIG_DEBUG_ATOMIC_SLEEP=y
+ CONFIG_PROVE_LOCKING=y
+ CONFIG_PROVE_RCU=y
+ CONFIG_LOCKDEP=y
+ CONFIG_DEBUG_MUTEXES=y
+
+EXAMPLES
+========
+
+Running mgmt-tester
+-------------------
+
+.. code-block::
+
+ $ tools/test-runner -k /pathto/bzImage -- tools/mgmt-tester
+
+Running a specific test of mgmt-tester
+--------------------------------------
+
+.. code-block::
+
+ $ tools/test-runner -k /pathto/bzImage -- tools/mgmt-tester -s "<name>"
+
+Running bluetoothctl with emulated controller
+---------------------------------------------
+
+.. code-block::
+
+ $ tools/test-runner -l -d -k /pathto/bzImage -- client/bluetoothctl
+ [CHG] Controller 00:AA:01:00:00:00 Pairable: yes
+ [bluetooth]#
+
+Running bluetoothctl with emulated controller and audio support
+---------------------------------------------------------------
+
+.. code-block::
+
+ $ tools/test-runner -l -d -A -k /pathto/bzImage -- client/bluetoothctl
+ [CHG] Controller 00:AA:01:00:00:00 Pairable: yes
+ [bluetooth]#
+ [CHG] Controller 00:AA:01:00:00:00 Pairable: yes
+ [CHG] Controller 00:AA:01:00:00:00 Class: 0x00600000 (6291456)
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110e-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000111f-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001200-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110b-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110a-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110c-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001800-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001801-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000180a-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000111e-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 Class: 0x006c0000 (7077888)
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110e-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000111f-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001200-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110b-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110a-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110c-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001800-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001801-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000180a-0000-1000-8000-00805f9b34fb
+ [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000111e-0000-1000-8000-00805f9b34fb
+
+Running shell with host controller using btproxy
+------------------------------------------------
+
+.. code-block::
+
+ $ tools/btproxy -u [1]
+ $ tools/test-runner -u -d -k /pathto/bzImage -- /bin/bash [2]
diff --git a/doc/test-runner.txt b/doc/test-runner.txt
deleted file mode 100644
index 43ce42be6b53..000000000000
--- a/doc/test-runner.txt
+++ /dev/null
@@ -1,85 +0,0 @@
-Notes for test-runner usage
-***************************
-
-
-Kernel configuration
-====================
-
-The test-runner tool requires a kernel that is at least build with these
-minimal options for a successful boot.
-
- CONFIG_VIRTIO=y
- CONFIG_VIRTIO_PCI=y
-
- CONFIG_NET=y
- CONFIG_INET=y
-
- CONFIG_NET_9P=y
- CONFIG_NET_9P_VIRTIO=y
-
- CONFIG_9P_FS=y
- CONFIG_9P_FS_POSIX_ACL=y
-
- CONFIG_SERIAL_8250=y
- CONFIG_SERIAL_8250_CONSOLE=y
- CONFIG_SERIAL_8250_PCI=y
- CONFIG_SERIAL_8250_NR_UARTS=4
-
- CONFIG_TMPFS=y
- CONFIG_TMPFS_POSIX_ACL=y
- CONFIG_TMPFS_XATTR=y
-
- CONFIG_DEVTMPFS=y
- CONFIG_DEBUG_FS=y
-
-For Bluetooth functionality:
-
- CONFIG_BT=y
- CONFIG_BT_BREDR=y
- CONFIG_BT_RFCOMM=y
- CONFIG_BT_BNEP=y
- CONFIG_BT_HIDP=y
- CONFIG_BT_LE=y
-
- CONFIG_BT_HCIUART=y
- CONFIG_BT_HCIUART_H4=y
- CONFIG_BT_HCIVHCI=y
-
- CONFIG_CRYPTO_CMAC=y
- CONFIG_CRYPTO_USER_API=y
- CONFIG_CRYPTO_USER_API_HASH=y
- CONFIG_CRYPTO_USER_API_SKCIPHER=y
-
- CONFIG_UNIX=y
-
- CONFIG_UHID=y
-
-For Audio functionality:
- CONFIG_SYSVIPC=y
- CONFIG_SOUND=y
- CONFIG_SND=y
- CONFIG_SND_INTEL8X0=y
-
-These options should be installed as .config in the kernel source directory
-followed by this command.
-
- make olddefconfig
-
-After that a default kernel with the required options can be built. More
-option (like the Bluetooth subsystem) can be enabled on top of this.
-
-Lock debuging
--------------
-
-To catch locking related issues the following set of kernel config
-options may be useful:
-
- CONFIG_DEBUG_KERNEL=y
- CONFIG_LOCKDEP_SUPPORT=y
- CONFIG_DEBUG_SPINLOCK=y
- CONFIG_DEBUG_LOCK_ALLOC=y
- CONFIG_DEBUG_ATOMIC_SLEEP=y
- CONFIG_PROVE_LOCKING=y
- CONFIG_PROVE_RCU=y
- CONFIG_LOCKDEP=y
- CONFIG_DEBUG_MUTEXES=y
diff --git a/tools/test-runner.rst b/tools/test-runner.rst
deleted file mode 100644
index ac3986ab14c0..000000000000
--- a/tools/test-runner.rst
+++ /dev/null
@@ -1,200 +0,0 @@
-===========
-test-runner
-===========
-
-------------------
-Kernel test runner
-------------------
-
-:Authors: - Luiz Augusto Von Dentz <luiz.von.dentz@intel.com>
-:Version: BlueZ
-:Copyright: Free use of this software is granted under ther terms of the GNU
- Lesser General Public Licenses (LGPL).
-:Date: Jul 6, 2023
-:Manual section: 1
-:Manual group: Linux System Administration
-
-SYNOPSIS
-========
-
-**test-runner** [*OPTIONS*] -- <test-name>
-
-DESCRIPTION
-===========
-
-**test-runner(1)** is used to test Kernel changes to the Bluetooth subsystem,
-it lunches a virtual machine using the local filesystem.
-
-OPTIONS
-=======
-
--a, --auto Find tests and run them
-
--b, --dbus Start D-Bus system daemon
-
--s, --dbus-session Start D-Bus session daemon
-
--d, --daemon Start bluetoothd
-
--m, --monitor Start btmon
-
--l, --emulator Start btvirt
-
--A, --audio[=path] Start audio server
-
--u, --unix [path] Provide serial device
-
--q, --qemu <path> QEMU binary
-
--k, --kernel <image> Kernel image (bzImage)
-
--h, --help Show help options
-
-Kernel
-======
-
-The test-runner tool requires a kernel that is at least build with these
-minimal options for a successful boot. These options should be installed as
-.config in the kernel source directory followed by:
-
-.. code-block::
-
- make olddefconfig
-
-After that a default kernel with the required options can be built. More
-option (like the Bluetooth subsystem) can be enabled on top of this.
-
-.. code-block::
-
- CONFIG_VIRTIO=y
- CONFIG_VIRTIO_PCI=y
-
- CONFIG_NET=y
- CONFIG_INET=y
-
- CONFIG_NET_9P=y
- CONFIG_NET_9P_VIRTIO=y
-
- CONFIG_9P_FS=y
- CONFIG_9P_FS_POSIX_ACL=y
-
- CONFIG_SERIAL_8250=y
- CONFIG_SERIAL_8250_CONSOLE=y
- CONFIG_SERIAL_8250_PCI=y
- CONFIG_SERIAL_8250_NR_UARTS=4
-
- CONFIG_TMPFS=y
- CONFIG_TMPFS_POSIX_ACL=y
- CONFIG_TMPFS_XATTR=y
-
- CONFIG_DEVTMPFS=y
- CONFIG_DEBUG_FS=y
-
-Bluetooth
----------
-
-.. code-block::
-
- CONFIG_BT=y
- CONFIG_BT_BREDR=y
- CONFIG_BT_RFCOMM=y
- CONFIG_BT_BNEP=y
- CONFIG_BT_HIDP=y
- CONFIG_BT_LE=y
-
- CONFIG_BT_HCIUART=y
- CONFIG_BT_HCIUART_H4=y
- CONFIG_BT_HCIVHCI=y
-
- CONFIG_CRYPTO_CMAC=y
- CONFIG_CRYPTO_USER_API=y
- CONFIG_CRYPTO_USER_API_HASH=y
- CONFIG_CRYPTO_USER_API_SKCIPHER=y
-
- CONFIG_UNIX=y
-
- CONFIG_UHID=y
-
-Lock debuging
--------------
-
-To catch locking related issues the following set of kernel config
-options may be useful:
-
-.. code-block::
-
- CONFIG_DEBUG_KERNEL=y
- CONFIG_LOCKDEP_SUPPORT=y
- CONFIG_DEBUG_SPINLOCK=y
- CONFIG_DEBUG_LOCK_ALLOC=y
- CONFIG_DEBUG_ATOMIC_SLEEP=y
- CONFIG_PROVE_LOCKING=y
- CONFIG_PROVE_RCU=y
- CONFIG_LOCKDEP=y
- CONFIG_DEBUG_MUTEXES=y
-
-EXAMPLES
-========
-
-Running mgmt-tester
--------------------
-
-.. code-block::
-
- $ tools/test-runner -k /pathto/bzImage -- tools/mgmt-tester
-
-Running a specific test of mgmt-tester
---------------------------------------
-
-.. code-block::
-
- $ tools/test-runner -k /pathto/bzImage -- tools/mgmt-tester -s "<name>"
-
-Running bluetoothctl with emulated controller
----------------------------------------------
-
-.. code-block::
-
- $ tools/test-runner -l -d -k /pathto/bzImage -- client/bluetoothctl
- [CHG] Controller 00:AA:01:00:00:00 Pairable: yes
- [bluetooth]#
-
-Running bluetoothctl with emulated controller and audio support
----------------------------------------------------------------
-
-.. code-block::
-
- $ tools/test-runner -l -d -A -k /pathto/bzImage -- client/bluetoothctl
- [CHG] Controller 00:AA:01:00:00:00 Pairable: yes
- [bluetooth]#
- [CHG] Controller 00:AA:01:00:00:00 Pairable: yes
- [CHG] Controller 00:AA:01:00:00:00 Class: 0x00600000 (6291456)
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110e-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000111f-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001200-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110b-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110a-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110c-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001800-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001801-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000180a-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000111e-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 Class: 0x006c0000 (7077888)
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110e-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000111f-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001200-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110b-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110a-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000110c-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001800-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 00001801-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000180a-0000-1000-8000-00805f9b34fb
- [CHG] Controller 00:AA:01:00:00:00 UUIDs: 0000111e-0000-1000-8000-00805f9b34fb
-
-Running shell with host controller using btproxy
-------------------------------------------------
-
-.. code-block::
-
- $ tools/btproxy -u [1]
- $ tools/test-runner -u -d -k /pathto/bzImage -- /bin/bash [2]
--
2.41.0
^ permalink raw reply related [flat|nested] 2+ messages in thread
* RE: [BlueZ] doc/test-runner: Update documentation using rst format
2023-08-14 19:15 [PATCH BlueZ] doc/test-runner: Update documentation using rst format Luiz Augusto von Dentz
@ 2023-08-14 20:34 ` bluez.test.bot
0 siblings, 0 replies; 2+ messages in thread
From: bluez.test.bot @ 2023-08-14 20:34 UTC (permalink / raw)
To: linux-bluetooth, luiz.dentz
[-- Attachment #1: Type: text/plain, Size: 1229 bytes --]
This is automated email and please do not reply to this email!
Dear submitter,
Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=776078
---Test result---
Test Summary:
CheckPatch PASS 0.51 seconds
GitLint PASS 0.36 seconds
BuildEll PASS 27.76 seconds
BluezMake PASS 888.87 seconds
MakeCheck PASS 12.54 seconds
MakeDistcheck FAIL 9.48 seconds
CheckValgrind PASS 259.50 seconds
CheckSmatch PASS 346.30 seconds
bluezmakeextell PASS 104.65 seconds
IncrementalBuild PASS 723.10 seconds
ScanBuild PASS 1078.96 seconds
Details
##############################
Test: MakeDistcheck - FAIL
Desc: Run Bluez Make Distcheck
Output:
make[2]: *** No rule to make target 'doc/test-runner.txt', needed by 'distdir-am'. Stop.
make[1]: *** [Makefile:11708: distdir] Error 2
make: *** [Makefile:11784: dist] Error 2
---
Regards,
Linux Bluetooth
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2023-08-14 20:35 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-08-14 19:15 [PATCH BlueZ] doc/test-runner: Update documentation using rst format Luiz Augusto von Dentz
2023-08-14 20:34 ` [BlueZ] " bluez.test.bot
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.