From 3fbf699b3fb0db6dedb479b57e38ac44b6f7b25f Mon Sep 17 00:00:00 2001 From: Luiz Augusto von Dentz Date: Mon, 14 Aug 2023 12:13:12 -0700 Subject: [PATCH] doc/test-runner: Update documentation using rst format This updates test-runner documentation with a few examples using rst format. --- {tools => doc}/test-runner.rst | 54 ++++++++------------------- doc/test-runner.txt | 85 ------------------------------------------ 2 files changed, 16 insertions(+), 123 deletions(-) rename {tools => doc}/test-runner.rst (82%) delete mode 100755 doc/test-runner.txt diff --git a/tools/test-runner.rst b/doc/test-runner.rst similarity index 82% rename from tools/test-runner.rst rename to doc/test-runner.rst index ac3986a..423a937 100644 --- a/tools/test-runner.rst +++ b/doc/test-runner.rst @@ -2,53 +2,29 @@ test-runner =========== ------------------- -Kernel test runner ------------------- - -:Authors: - Luiz Augusto Von Dentz -: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*] -- DESCRIPTION =========== **test-runner(1)** is used to test Kernel changes to the Bluetooth subsystem, -it lunches a virtual machine using the local filesystem. +it lunches a virtual machine using qemu(1) and mounts the local filesystem +using virtio (9p). 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 QEMU binary - --k, --kernel Kernel image (bzImage) - --h, --help Show help 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=: QEMU binary +:-k/--kernel=: Kernel image (bzImage) +:-h/--help: Show help options Kernel ====== @@ -80,7 +56,7 @@ option (like the Bluetooth subsystem) can be enabled on top of this. CONFIG_SERIAL_8250=y CONFIG_SERIAL_8250_CONSOLE=y - CONFIG_SERIAL_8250_PCI=y + CONFIG_SERIAL_8250_PCI=yCONFIG_DEBUG_KERNEL=y CONFIG_SERIAL_8250_NR_UARTS=4 CONFIG_TMPFS=y @@ -132,6 +108,7 @@ options may be useful: CONFIG_PROVE_RCU=y CONFIG_LOCKDEP=y CONFIG_DEBUG_MUTEXES=y + CONFIG_KASAN=y EXAMPLES ======== @@ -198,3 +175,4 @@ Running shell with host controller using btproxy $ 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 100755 index 43ce42b..0000000 --- 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 -- 2.7.4