From 0f5d0f3555603d871a931601d5759b1958af4802 Mon Sep 17 00:00:00 2001 From: Emil Gydesen Date: Wed, 28 Aug 2024 15:19:24 +0200 Subject: [PATCH] samples: Bluetooth: ISO: Rename ISO central and peripheral The samples had a _iso suffix, but the other ISO samples prefix iso_. Renames the central and peripheral sample so that they prefix iso_ rather than suffix _iso. Signed-off-by: Emil Gydesen --- MAINTAINERS.yml | 2 -- doc/_scripts/redirects.py | 2 ++ .../bluetooth/{central_iso => iso_central}/CMakeLists.txt | 0 samples/bluetooth/{central_iso => iso_central}/README.rst | 8 ++++---- .../overlay-bt_ll_sw_split.conf | 0 samples/bluetooth/{central_iso => iso_central}/prj.conf | 0 .../bluetooth/{central_iso => iso_central}/sample.yaml | 4 ++-- samples/bluetooth/{central_iso => iso_central}/src/main.c | 0 .../{peripheral_iso => iso_peripheral}/CMakeLists.txt | 2 +- .../{peripheral_iso => iso_peripheral}/README.rst | 8 ++++---- .../bluetooth/{peripheral_iso => iso_peripheral}/prj.conf | 0 .../{peripheral_iso => iso_peripheral}/sample.yaml | 2 +- .../{peripheral_iso => iso_peripheral}/src/main.c | 0 13 files changed, 14 insertions(+), 14 deletions(-) rename samples/bluetooth/{central_iso => iso_central}/CMakeLists.txt (100%) rename samples/bluetooth/{central_iso => iso_central}/README.rst (88%) rename samples/bluetooth/{central_iso => iso_central}/overlay-bt_ll_sw_split.conf (100%) rename samples/bluetooth/{central_iso => iso_central}/prj.conf (100%) rename samples/bluetooth/{central_iso => iso_central}/sample.yaml (86%) rename samples/bluetooth/{central_iso => iso_central}/src/main.c (100%) rename samples/bluetooth/{peripheral_iso => iso_peripheral}/CMakeLists.txt (91%) rename samples/bluetooth/{peripheral_iso => iso_peripheral}/README.rst (90%) rename samples/bluetooth/{peripheral_iso => iso_peripheral}/prj.conf (100%) rename samples/bluetooth/{peripheral_iso => iso_peripheral}/sample.yaml (87%) rename samples/bluetooth/{peripheral_iso => iso_peripheral}/src/main.c (100%) diff --git a/MAINTAINERS.yml b/MAINTAINERS.yml index 28952fcf27e..9517e3138f4 100644 --- a/MAINTAINERS.yml +++ b/MAINTAINERS.yml @@ -404,7 +404,6 @@ Bluetooth Host: - samples/bluetooth/hci_*/ - samples/bluetooth/pbp*/ - samples/bluetooth/tmap*/ - - samples/bluetooth/*_iso/ - samples/bluetooth/iso_*/ - samples/bluetooth/mesh*/ - subsys/bluetooth/shell/bredr.c @@ -522,7 +521,6 @@ Bluetooth ISO: files: - include/zephyr/bluetooth/iso.h - doc/connectivity/bluetooth/api/shell/iso.rst - - samples/bluetooth/*_iso/ - samples/bluetooth/iso_*/ - subsys/bluetooth/shell/iso.c - subsys/bluetooth/Kconfig.iso diff --git a/doc/_scripts/redirects.py b/doc/_scripts/redirects.py index e1dede24960..2790869abd5 100644 --- a/doc/_scripts/redirects.py +++ b/doc/_scripts/redirects.py @@ -206,6 +206,8 @@ REDIRECTS = [ ('samples/bluetooth/broadcast_audio_assistant/README', 'samples/bluetooth/bap_broadcast_assistant/README'), ('samples/bluetooth/broadcast_audio_sink/README', 'samples/bluetooth/bap_broadcast_sink/README'), ('samples/bluetooth/broadcast_audio_source/README', 'samples/bluetooth/bap_broadcast_source/README'), + ('samples/bluetooth/central_iso/README', 'samples/bluetooth/iso_central/README'), + ('samples/bluetooth/peripheral_iso/README', 'samples/bluetooth/iso_peripheral/README'), ('samples/bluetooth/public_broadcast_sink/README', 'samples/bluetooth/pbp_public_broadcast_sink/README'), ('samples/bluetooth/public_broadcast_source/README', 'samples/bluetooth/pbp_public_broadcast_source/README'), ('samples/bluetooth/unicast_audio_client/README', 'samples/bluetooth/bap_unicast_client/README'), diff --git a/samples/bluetooth/central_iso/CMakeLists.txt b/samples/bluetooth/iso_central/CMakeLists.txt similarity index 100% rename from samples/bluetooth/central_iso/CMakeLists.txt rename to samples/bluetooth/iso_central/CMakeLists.txt diff --git a/samples/bluetooth/central_iso/README.rst b/samples/bluetooth/iso_central/README.rst similarity index 88% rename from samples/bluetooth/central_iso/README.rst rename to samples/bluetooth/iso_central/README.rst index 13e6f56d778..9e6c509485b 100644 --- a/samples/bluetooth/central_iso/README.rst +++ b/samples/bluetooth/iso_central/README.rst @@ -1,6 +1,6 @@ -.. _bluetooth_central_iso: +.. _bluetooth_iso_central: -Bluetooth: Central ISO +Bluetooth: ISO Central ###################### Overview @@ -9,7 +9,7 @@ Overview This sample demonstrates how to use an isochronous channel as a central. The sample scans for a peripheral, establishes a connection, and sets up a connected isochronous channel to it. Once the isochronous channel is connected, isochronous data is transferred to the peer device every 10 milliseconds. -It is recommended to run this sample together with the :ref:`Bluetooth: Peripheral ISO ` sample. +It is recommended to run this sample together with the :ref:`Bluetooth: ISO Peripheral ` sample. To run the sample with an encrypted isochronous channel, enable :kconfig:option:`CONFIG_BT_SMP`. @@ -23,7 +23,7 @@ Requirements Building and Running ******************** -This sample can be found under :zephyr_file:`samples/bluetooth/central_iso` in +This sample can be found under :zephyr_file:`samples/bluetooth/iso_central` in the Zephyr tree. 1. Start the application. diff --git a/samples/bluetooth/central_iso/overlay-bt_ll_sw_split.conf b/samples/bluetooth/iso_central/overlay-bt_ll_sw_split.conf similarity index 100% rename from samples/bluetooth/central_iso/overlay-bt_ll_sw_split.conf rename to samples/bluetooth/iso_central/overlay-bt_ll_sw_split.conf diff --git a/samples/bluetooth/central_iso/prj.conf b/samples/bluetooth/iso_central/prj.conf similarity index 100% rename from samples/bluetooth/central_iso/prj.conf rename to samples/bluetooth/iso_central/prj.conf diff --git a/samples/bluetooth/central_iso/sample.yaml b/samples/bluetooth/iso_central/sample.yaml similarity index 86% rename from samples/bluetooth/central_iso/sample.yaml rename to samples/bluetooth/iso_central/sample.yaml index 455ff8fcb00..d4350e0d9cf 100644 --- a/samples/bluetooth/central_iso/sample.yaml +++ b/samples/bluetooth/iso_central/sample.yaml @@ -2,13 +2,13 @@ sample: description: Bluetooth ISO central (client) sample name: Bluetooth ISO central (client) sample tests: - sample.bluetooth.central_iso: + sample.bluetooth.iso_central: harness: bluetooth platform_allow: qemu_x86 integration_platforms: - qemu_x86 tags: bluetooth - sample.bluetooth.central_iso.bt_ll_sw_split: + sample.bluetooth.iso_central.bt_ll_sw_split: harness: bluetooth platform_allow: - qemu_cortex_m3 diff --git a/samples/bluetooth/central_iso/src/main.c b/samples/bluetooth/iso_central/src/main.c similarity index 100% rename from samples/bluetooth/central_iso/src/main.c rename to samples/bluetooth/iso_central/src/main.c diff --git a/samples/bluetooth/peripheral_iso/CMakeLists.txt b/samples/bluetooth/iso_peripheral/CMakeLists.txt similarity index 91% rename from samples/bluetooth/peripheral_iso/CMakeLists.txt rename to samples/bluetooth/iso_peripheral/CMakeLists.txt index c2f8d92d824..cc67b1d71aa 100644 --- a/samples/bluetooth/peripheral_iso/CMakeLists.txt +++ b/samples/bluetooth/iso_peripheral/CMakeLists.txt @@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.20.0) find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE}) -project(peripheral_iso) +project(iso_peripheral) target_sources(app PRIVATE src/main.c diff --git a/samples/bluetooth/peripheral_iso/README.rst b/samples/bluetooth/iso_peripheral/README.rst similarity index 90% rename from samples/bluetooth/peripheral_iso/README.rst rename to samples/bluetooth/iso_peripheral/README.rst index d877cf3a98f..a01232fd38b 100644 --- a/samples/bluetooth/peripheral_iso/README.rst +++ b/samples/bluetooth/iso_peripheral/README.rst @@ -1,6 +1,6 @@ -.. _peripheral_iso: +.. _iso_peripheral: -Bluetooth: Peripheral ISO +Bluetooth: ISO Peripheral ######################### Overview @@ -9,7 +9,7 @@ Overview This sample demonstrates how to use isochronous channels as a peripheral. The sample starts advertising, waits for a central to connect to it and set up an isochronous channel. Once the isochronous channel is set up, received isochronous data is printed out. -It is recommended to run this sample together with the :ref:`Bluetooth: Central ISO ` sample. +It is recommended to run this sample together with the :ref:`Bluetooth: Central ISO ` sample. Requirements ************ @@ -22,7 +22,7 @@ Requirements Building and Running ******************** -This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_iso` in the Zephyr tree. +This sample can be found under :zephyr_file:`samples/bluetooth/iso_peripheral` in the Zephyr tree. 1. Start the application. In the terminal window, check that it is advertising. diff --git a/samples/bluetooth/peripheral_iso/prj.conf b/samples/bluetooth/iso_peripheral/prj.conf similarity index 100% rename from samples/bluetooth/peripheral_iso/prj.conf rename to samples/bluetooth/iso_peripheral/prj.conf diff --git a/samples/bluetooth/peripheral_iso/sample.yaml b/samples/bluetooth/iso_peripheral/sample.yaml similarity index 87% rename from samples/bluetooth/peripheral_iso/sample.yaml rename to samples/bluetooth/iso_peripheral/sample.yaml index 29e859e341c..fdd0f18e249 100644 --- a/samples/bluetooth/peripheral_iso/sample.yaml +++ b/samples/bluetooth/iso_peripheral/sample.yaml @@ -2,7 +2,7 @@ sample: description: Bluetooth ISO peripheral (server) sample name: Bluetooth ISO peripheral (server) sample tests: - sample.bluetooth.peripheral_iso: + sample.bluetooth.iso_peripheral: harness: bluetooth platform_allow: qemu_x86 tags: bluetooth diff --git a/samples/bluetooth/peripheral_iso/src/main.c b/samples/bluetooth/iso_peripheral/src/main.c similarity index 100% rename from samples/bluetooth/peripheral_iso/src/main.c rename to samples/bluetooth/iso_peripheral/src/main.c