From d77719ee37824bab9b041f8796ac17dd15ac624e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Fri, 30 Aug 2024 14:52:41 +0200 Subject: [PATCH] doc: redirects: cleanup stale or broken entries MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixed entries pointing to invalid destinations either due to resource having been removed or moved once more, or entries being plain broken from day 1. Signed-off-by: Benjamin Cabé --- doc/_scripts/redirects.py | 55 ++++++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 24 deletions(-) diff --git a/doc/_scripts/redirects.py b/doc/_scripts/redirects.py index 2790869abd5..074fa964ed7 100644 --- a/doc/_scripts/redirects.py +++ b/doc/_scripts/redirects.py @@ -17,6 +17,8 @@ REDIRECTS = [ ('application/index', 'develop/application/index'), ('boards/arduino/uno_r4_minima/doc/index', 'boards/arduino/uno_r4/doc/index'), ('boards/x86/ehl_crb/doc/index', 'boards/x86/intel_ehl/doc/index'), + ('boards/x86/intel_ehl/doc/index', 'boards/intel/ehl/doc/index'), + ('boards/x86/intel_rpl/doc/index', 'boards/intel/rpl/doc/index'), ('boards/x86/rpl_crb/doc/index', 'boards/x86/intel_rpl/doc/index'), ('connectivity/bluetooth/audio', 'connectivity/bluetooth/api/audio/audio'), ('connectivity/bluetooth/bap', 'connectivity/bluetooth/api/audio/bap'), @@ -24,15 +26,22 @@ REDIRECTS = [ ('connectivity/bluetooth/bluetooth-le-audio-arch', 'connectivity/bluetooth/api/audio/bluetooth-le-audio-arch'), ('connectivity/bluetooth/cap', 'connectivity/bluetooth/api/audio/cap'), ('connectivity/bluetooth/coordinated_sets', 'connectivity/bluetooth/api/audio/coordinated_sets'), - ('connectivity/bluetooth/dis-pics', 'connectivity/bluetooth/ics/dis'), - ('connectivity/bluetooth/gap-pics', 'connectivity/bluetooth/ics/gap'), - ('connectivity/bluetooth/gatt-pics', 'connectivity/bluetooth/ics/gatt'), - ('connectivity/bluetooth/l2cap-pics', 'connectivity/bluetooth/ics/l2cap'), + ('connectivity/bluetooth/dis-pics', 'connectivity/bluetooth/bluetooth-qual'), + ('connectivity/bluetooth/gap-pics', 'connectivity/bluetooth/bluetooth-qual'), + ('connectivity/bluetooth/gatt-pics', 'connectivity/bluetooth/bluetooth-qual'), + ('connectivity/bluetooth/ics/dis', 'connectivity/bluetooth/bluetooth-qual'), + ('connectivity/bluetooth/ics/gap', 'connectivity/bluetooth/bluetooth-qual'), + ('connectivity/bluetooth/ics/gatt', 'connectivity/bluetooth/bluetooth-qual'), + ('connectivity/bluetooth/ics/l2cap', 'connectivity/bluetooth/bluetooth-qual'), + ('connectivity/bluetooth/ics/mesh', 'connectivity/bluetooth/bluetooth-qual'), + ('connectivity/bluetooth/ics/rfcomm', 'connectivity/bluetooth/bluetooth-qual'), + ('connectivity/bluetooth/ics/sm', 'connectivity/bluetooth/bluetooth-qual'), + ('connectivity/bluetooth/l2cap-pics', 'connectivity/bluetooth/bluetooth-qual'), ('connectivity/bluetooth/media', 'connectivity/bluetooth/api/audio/media'), - ('connectivity/bluetooth/mesh-pics', 'connectivity/bluetooth/ics/mesh'), + ('connectivity/bluetooth/mesh-pics', 'connectivity/bluetooth/bluetooth-qual'), ('connectivity/bluetooth/microphone', 'connectivity/bluetooth/api/audio/microphone'), ('connectivity/bluetooth/overview', 'connectivity/bluetooth/features'), - ('connectivity/bluetooth/rfcomm-pics', 'connectivity/bluetooth/ics/rfcomm'), + ('connectivity/bluetooth/rfcomm-pics', 'connectivity/bluetooth/bluetooth-qual'), ('connectivity/bluetooth/shell/bap', 'connectivity/bluetooth/api/audio/shell/bap'), ('connectivity/bluetooth/shell/bap_broadcast_assistant', 'connectivity/bluetooth/api/audio/shell/bap_broadcast_assistant'), ('connectivity/bluetooth/shell/bap_scan_delegator', 'connectivity/bluetooth/api/audio/shell/bap_scan_delegator'), @@ -43,7 +52,7 @@ REDIRECTS = [ ('connectivity/bluetooth/shell/mcp', 'connectivity/bluetooth/api/audio/shell/mcp'), ('connectivity/bluetooth/shell/pbp', 'connectivity/bluetooth/api/audio/shell/pbp'), ('connectivity/bluetooth/shell/tmap', 'connectivity/bluetooth/api/audio/shell/tmap'), - ('connectivity/bluetooth/sm-pics', 'connectivity/bluetooth/ics/sm'), + ('connectivity/bluetooth/sm-pics', 'connectivity/bluetooth/bluetooth-qual'), ('connectivity/bluetooth/volume', 'connectivity/bluetooth/api/audio/volume'), ('connectivity/networking/networking-api-usage', 'connectivity/networking/api/index'), ('development_process/code_flow', 'project/code_flow'), @@ -59,7 +68,7 @@ REDIRECTS = [ ('guides/arch/x86', 'hardware/arch/x86'), ('guides/beyond-GSG', 'develop/beyond-GSG'), ('guides/bluetooth/index', 'connectivity/bluetooth/index'), - ('guides/bluetooth/sm-pics', 'connectivity/bluetooth/sm-pics'), + ('guides/bluetooth/sm-pics', 'connectivity/bluetooth/bluetooth-qual'), ('guides/build/index', 'build/cmake/index'), ('guides/build/kconfig/extensions', 'build/kconfig/extensions'), ('guides/build/kconfig/menuconfig', 'build/kconfig/menuconfig'), @@ -81,8 +90,6 @@ REDIRECTS = [ ('guides/dts/howtos', 'build/dts/howtos'), ('guides/dts/index', 'build/dts/index'), ('guides/dts/intro', 'build/dts/intro'), - ('guides/dts/macros.bnf', 'build/dts/macros.bnf'), - ('guides/dts/main-example.dts', 'build/dts/main-example.dts'), ('guides/dts/troubleshooting', 'build/dts/troubleshooting'), ('guides/emulator/index', 'hardware/emulator/index'), ('guides/env_vars', 'develop/env_vars'), @@ -100,7 +107,7 @@ REDIRECTS = [ ('guides/optimizations/index', 'develop/optimizations/index'), ('guides/optimizations/tools', 'develop/optimizations/tools'), ('guides/pinctrl/index', 'hardware/pinctrl/index'), - ('guides/platformio/index', 'develop/tools/platformio/index'), + ('guides/platformio/index', 'develop/tools/index'), ('guides/pm/device', 'services/pm/device'), ('guides/pm/device_runtime', 'services/pm/device_runtime'), ('guides/pm/index', 'services/pm/index'), @@ -115,7 +122,6 @@ REDIRECTS = [ ('guides/smf/index', 'services/smf/index'), ('guides/test/coverage', 'develop/test/coverage'), ('guides/test/index', 'develop/test/index'), - ('guides/test/mocking.c', 'develop/test/mocking.c'), ('guides/test/twister', 'develop/test/twister'), ('guides/test/ztest', 'develop/test/ztest'), ('guides/tfm/build', 'services/tfm/build'), @@ -137,7 +143,6 @@ REDIRECTS = [ ('guides/west/sign', 'develop/west/sign'), ('guides/west/troubleshooting', 'develop/west/troubleshooting'), ('guides/west/west-apis', 'develop/west/west-apis'), - ('guides/west/west-not-found', 'develop/west/west-not-found'), ('guides/west/why', 'develop/west/why'), ('guides/west/without-west', 'develop/west/without-west'), ('guides/west/workspaces', 'develop/west/workspaces'), @@ -145,6 +150,7 @@ REDIRECTS = [ ('guides/zephyr_cmake_package', 'build/zephyr_cmake_package'), ('hardware/peripherals/eeprom', 'hardware/peripherals/eeprom/index'), ('hardware/peripherals/sensor', 'hardware/peripherals/sensor/index'), + ('kernel/libc/index', 'develop/languages/c/index'), ('reference/api/api_lifecycle', 'develop/api/api_lifecycle'), ('reference/api/index', 'develop/api/index'), ('reference/api/overview', 'develop/api/overview'), @@ -160,10 +166,10 @@ REDIRECTS = [ ('reference/peripherals/adc', 'hardware/peripherals/adc'), ('reference/peripherals/dac', 'hardware/peripherals/dac'), ('reference/peripherals/dma', 'hardware/peripherals/dma'), - ('reference/peripherals/eeprom', 'hardware/peripherals/eeprom'), + ('reference/peripherals/eeprom', 'hardware/peripherals/eeprom/index'), ('reference/peripherals/espi', 'hardware/peripherals/espi'), ('reference/peripherals/flash', 'hardware/peripherals/flash'), - ('reference/peripherals/gna', 'hardware/peripherals/gna'), + ('reference/peripherals/gna', 'hardware/peripherals/index'), ('reference/peripherals/gpio', 'hardware/peripherals/gpio'), ('reference/peripherals/hwinfo', 'hardware/peripherals/hwinfo'), ('reference/peripherals/i2c', 'hardware/peripherals/i2c'), @@ -175,12 +181,12 @@ REDIRECTS = [ ('reference/peripherals/mdio', 'hardware/peripherals/mdio'), ('reference/peripherals/mspi', 'hardware/peripherals/mspi'), ('reference/peripherals/peci', 'hardware/peripherals/peci'), - ('reference/peripherals/pinmux', 'hardware/peripherals/pinmux'), + ('reference/peripherals/pinmux', 'hardware/pinctrl/index'), ('reference/peripherals/ps2', 'hardware/peripherals/ps2'), ('reference/peripherals/pwm', 'hardware/peripherals/pwm'), ('reference/peripherals/reset', 'hardware/peripherals/reset'), ('reference/peripherals/rtc', 'hardware/peripherals/rtc'), - ('reference/peripherals/sensor', 'hardware/peripherals/sensor'), + ('reference/peripherals/sensor', 'hardware/peripherals/sensor/index'), ('reference/peripherals/spi', 'hardware/peripherals/spi'), ('reference/peripherals/tcpc', 'hardware/peripherals/tcpc'), ('reference/peripherals/uart', 'hardware/peripherals/uart'), @@ -192,12 +198,12 @@ REDIRECTS = [ ('reference/storage/index', 'services/storage/index'), ('reference/storage/nvs/nvs', 'services/storage/nvs/nvs'), ('reference/task_wdt/index', 'services/task_wdt/index'), - ('reference/usb/hid', 'services/usb/hid'), - ('reference/usb/index', 'services/usb/index'), - ('reference/usb/udc', 'services/usb/udc'), - ('reference/usb/uds', 'services/usb/uds'), - ('reference/usb/uds_cdc_acm', 'services/usb/uds_cdc_acm'), - ('reference/usb/uds_testing', 'services/usb/uds_testing'), + ('reference/usb/hid', 'connectivity/usb/device/api/usb_device_hid'), + ('reference/usb/index', 'connectivity/usb/device/usb_device'), + ('reference/usb/udc', 'connectivity/usb/device/api/usb_dc'), + ('reference/usb/uds', 'connectivity/usb/device/usb_device'), + ('reference/usb/uds_cdc_acm', 'connectivity/usb/device/usb_device'), + ('reference/usb/uds_testing', 'connectivity/usb/device/usb_device'), ('reference/usermode/index', 'kernel/usermode/index'), ('reference/usermode/overview', 'kernel/usermode/overview'), ('reference/usermode/syscalls', 'kernel/usermode/syscalls'), @@ -217,12 +223,13 @@ REDIRECTS = [ ('samples/drivers/led_apa102/README', 'samples/drivers/led_strip/README'), ('samples/drivers/led_lpd8806/README', 'samples/drivers/led_strip/README'), ('samples/drivers/led_ws2812/README', 'samples/drivers/led_strip/README'), - ('samples/net/cloud/google_iot_mqtt/README', 'samples/net/cloud/cloud'), + ('samples/net/cloud/google_iot_mqtt/README', 'samples/net/net'), ('samples/sensor/wsen_hids/README', 'samples/sensor/sensor'), ('samples/sensor/wsen_itds/README', 'samples/sensor/sensor'), ('samples/subsys/video/capture/README', 'samples/drivers/video/capture/README'), ('samples/subsys/video/tcpserversink/README', 'samples/drivers/video/tcpserversink/README'), ('samples/subsys/video/video', 'samples/drivers/video/video'), + ('services/crypto/tinycrypt', 'services/crypto/psa_crypto'), ('services/portability/posix', 'services/portability/posix/index'), # zephyr-keep-sorted-stop ]