diff --git a/doc/bridle/app_boards.rst b/doc/bridle/app_boards.rst index 08e7076308..b27bbb9ef9 100644 --- a/doc/bridle/app_boards.rst +++ b/doc/bridle/app_boards.rst @@ -22,25 +22,48 @@ Boards included in tiac-zephyr ============================== The following boards are defined in the :file:`zephyr/boards/` folder. -Also see the :ref:`zephyr:boards` section in the Zephyr documentation. - -.. _table: - -+-------------------+---------------------------------------+------------------------+ -| Hardware platform | Board name | Build target | -+===================+=======================================+========================+ -| Native | :ref:`zephyr:native_posix` | ``native_posix`` | -+-------------------+---------------------------------------+------------------------+ -| Emulator | :ref:`zephyr:qemu_x86` | ``qemu_x86`` | -| +---------------------------------------+------------------------+ -| | :ref:`zephyr:qemu_cortex_m3` | ``qemu_cortex_m3`` | -+-------------------+---------------------------------------+------------------------+ -| ATSAMD21G18A | :ref:`zephyr:arduino_zero` | ``arduino_zero`` | -| +---------------------------------------+------------------------+ -| | :ref:`zephyr:seeeduino_xiao` | ``seeeduino_xiao`` | -+-------------------+---------------------------------------+------------------------+ -| STM32F746ZG | :ref:`zephyr:nucleo_f746zg_board` | ``nucleo_f746zg`` | -+-------------------+---------------------------------------+------------------------+ +Also see the :ref:`zephyr:boards` section in the |ZEPHYR| documentation. + ++-------------------+-----------------------------------+-----------------------------------+ +| Hardware platform | Board name | Build target | ++===================+===================================+===================================+ +| Native | :ref:`zephyr:native_posix` | ``native_posix`` | ++-------------------+-----------------------------------+-----------------------------------+ +| Emulator | :ref:`zephyr:qemu_x86` | ``qemu_x86`` | +| +-----------------------------------+-----------------------------------+ +| | :ref:`zephyr:qemu_cortex_m3` | ``qemu_cortex_m3`` | ++-------------------+-----------------------------------+-----------------------------------+ +| ATSAMD21G18A | :ref:`zephyr:arduino_zero` | ``arduino_zero`` | +| +-----------------------------------+-----------------------------------+ +| | :ref:`zephyr:seeeduino_xiao` | ``seeeduino_xiao`` | ++-------------------+-----------------------------------+-----------------------------------+ +| i.MX RT1010 | :ref:`zephyr:mimxrt1010_evk` | ``mimxrt1010_evk`` | ++-------------------+-----------------------------------+-----------------------------------+ +| i.MX RT1060 | :ref:`zephyr:mimxrt1060_evk` | | ``mimxrt1060_evk`` | +| | | | ``mimxrt1060_evkb`` | ++-------------------+-----------------------------------+-----------------------------------+ +| i.MX RT1170 (CM7) | :ref:`zephyr:mimxrt1170_evk` | ``mimxrt1170_evk/mimxrt1176/cm7`` | ++-------------------+-----------------------------------+-----------------------------------+ +| nRF52840 | :ref:`zephyr:nrf52840dk_nrf52840` | ``nrf52840dk/nrf52840`` | ++-------------------+-----------------------------------+-----------------------------------+ +| nRF9160 | :ref:`zephyr:nrf9160dk_nrf9160` | | ``nrf9160dk/nrf9160`` | +| | | | ``nrf9160dk/nrf9160/ns`` | ++-------------------+-----------------------------------+-----------------------------------+ +| RP2040 | :ref:`zephyr:rpi_pico` | | ``rpi_pico`` | +| | | | ``rpi_pico/rp2040/w`` | ++-------------------+-----------------------------------+-----------------------------------+ +| STM32F303RE | :ref:`zephyr:nucleo_f303re_board` | ``nucleo_f303re`` | ++-------------------+-----------------------------------+-----------------------------------+ +| STM32F401RE | :ref:`zephyr:nucleo_f401re_board` | ``nucleo_f401re`` | ++-------------------+-----------------------------------+-----------------------------------+ +| STM32F413ZH | :ref:`zephyr:nucleo_f413zh_board` | ``nucleo_f413zh`` | ++-------------------+-----------------------------------+-----------------------------------+ +| STM32F746ZG | :ref:`zephyr:nucleo_f746zg_board` | ``nucleo_f746zg`` | ++-------------------+-----------------------------------+-----------------------------------+ +| STM32F767ZI | :ref:`zephyr:nucleo_f767zi_board` | ``nucleo_f767zi`` | ++-------------------+-----------------------------------+-----------------------------------+ +| STM32L496ZG | :ref:`zephyr:nucleo_l496zg_board` | ``nucleo_l496zg`` | ++-------------------+-----------------------------------+-----------------------------------+ Boards included in tiac-bridle @@ -49,111 +72,191 @@ Boards included in tiac-bridle The following boards are defined in the :file:`bridle/boards/` folder. Also see the :ref:`boards` section in this documentation. -+-------------------+---------------------------------------+----------------------------------+ -| Hardware platform | Board name | Build target | -+===================+=======================================+==================================+ -| ATSAMD21G18A | :ref:`arduino_zero` | ``arduino_zero`` | -| +---------------------------------------+----------------------------------+ -| | :ref:`xiao_samd21` | ``xiao_samd21`` | -| +---------------------------------------+----------------------------------+ -| | :ref:`seeeduino_cm0` | ``seeeduino_cm0`` | -| +---------------------------------------+----------------------------------+ -| | :ref:`seeeduino_lotus` | ``seeeduino_lotus`` | -+-------------------+---------------------------------------+----------------------------------+ -| RP2040 | :ref:`cytron_maker_rp2040` | | ``cytron_maker_nano_rp2040`` | -| | | | ``cytron_maker_pi_rp2040`` | -| +---------------------------------------+----------------------------------+ -| | :ref:`picoboy_board` | ``picoboy`` | -| +---------------------------------------+----------------------------------+ -| | :ref:`waveshare_rp2040` | | ``waveshare_rp2040_one`` | -| | | | ``waveshare_rp2040_zero`` | -| | | | ``waveshare_rp2040_matrix`` | -| | | | ``waveshare_rp2040_tiny`` | -| | | | ``waveshare_rp2040_eth`` | -| | | | ``waveshare_rp2040_lcd_0_96`` | -| | | | ``waveshare_rp2040_plus`` | -| | | | ``waveshare_rp2040_plus@16mb`` | -| | | | ``waveshare_rp2040_geek`` | -+-------------------+---------------------------------------+----------------------------------+ -| STM32F777NI | :ref:`magpie_f777ni_board` | ``magpie_f777ni`` | -+-------------------+---------------------------------------+----------------------------------+ ++-------------------+----------------------------+----------------------------------+ +| Hardware platform | Board name | Build target | ++===================+============================+==================================+ +| ATSAMD21G18A | :ref:`arduino_zero` | ``arduino_zero`` | +| +----------------------------+----------------------------------+ +| | :ref:`xiao_samd21` | ``xiao_samd21`` | +| +----------------------------+----------------------------------+ +| | :ref:`seeeduino_cm0` | ``seeeduino_cm0`` | +| +----------------------------+----------------------------------+ +| | :ref:`seeeduino_lotus` | ``seeeduino_lotus`` | ++-------------------+----------------------------+----------------------------------+ +| RP2040 | :ref:`cytron_maker_rp2040` | | ``cytron_maker_nano_rp2040`` | +| | | | ``cytron_maker_pi_rp2040`` | +| +----------------------------+----------------------------------+ +| | :ref:`picoboy_board` | ``picoboy`` | +| +----------------------------+----------------------------------+ +| | :ref:`waveshare_rp2040` | | ``waveshare_rp2040_one`` | +| | | | ``waveshare_rp2040_zero`` | +| | | | ``waveshare_rp2040_matrix`` | +| | | | ``waveshare_rp2040_tiny`` | +| | | | ``waveshare_rp2040_eth`` | +| | | | ``waveshare_rp2040_lcd_0_96`` | +| | | | ``waveshare_rp2040_plus`` | +| | | | ``waveshare_rp2040_plus@16mb`` | +| | | | ``waveshare_rp2040_geek`` | ++-------------------+----------------------------+----------------------------------+ +| STM32F777NI | :ref:`magpie_f777ni_board` | ``magpie_f777ni`` | ++-------------------+----------------------------+----------------------------------+ + +Shield names +************ + +The following tables list all shields and build targets for |TIAC| +hardware platforms. Shields included in tiac-bridle =============================== The following shields are defined in the :file:`bridle/boards/shields/` folder. -+------------------------------------------+------------------------------------------+----------------------------------------+ -| Hardware platform | Shield name | Build target | -+==========================================+==========================================+========================================+ -| Common for testing | :ref:`loopback_test_shield` | | ``loopback_test`` | -| | | | ``loopback_test_tmph`` | -+------------------------------------------+------------------------------------------+----------------------------------------+ -| :ref:`grove_shield` | :ref:`grove_base_shield_v2` | ``seeed_grove_base_v2`` | -| +------------------------------------------+----------------------------------------+ -| | :ref:`grove_base_shield_v1` | ``seeed_grove_base_v1`` | -| +------------------------------------------+----------------------------------------+ -| | :ref:`grove_base_shield_xiao_v1` | ``seeed_grove_xiao_v1`` | -| +------------------------------------------+----------------------------------------+ -| | :ref:`grove_rpipico_shield_v1` | ``seeed_grove_rpipico_v1`` | -| +------------------------------------------+----------------------------------------+ -| | :ref:`grove_button_shield` | ``grove_btn_d[0…31]`` | -| +------------------------------------------+----------------------------------------+ -| | :ref:`grove_led_shield` | ``grove_led_d[0…31]`` | -| +------------------------------------------+----------------------------------------+ -| | :ref:`x_grove_testbed_shield` | ``x_grove_testbed`` | -+------------------------------------------+------------------------------------------+----------------------------------------+ -| :ref:`rpi_pico_clock_shield` | |Waveshare Pico Clock Green| | ``waveshare_pico_clock_green`` | -+------------------------------------------+------------------------------------------+----------------------------------------+ -| :ref:`rpi_pico_lcd_shield` | |Waveshare Pico LCD 1.14| | ``waveshare_pico_lcd_1_14`` | -| +------------------------------------------+----------------------------------------+ -| | |Waveshare Pico LCD 2| | ``waveshare_pico_lcd_2`` | -| +------------------------------------------+----------------------------------------+ -| | |Waveshare Pico ResTouch LCD 3.5| | ``waveshare_pico_restouch_lcd_3_5`` | -+------------------------------------------+------------------------------------------+----------------------------------------+ -| :ref:`rpi_pico_led_shield` | |Waveshare Pico RGB LED| | ``waveshare_pico_rgb_led`` | -+------------------------------------------+------------------------------------------+----------------------------------------+ -| :ref:`rpi_pico_test_shield` | |Spotpear Pico ALL GPIO TEST| | ``spotpear_pico_test`` | -+------------------------------------------+------------------------------------------+----------------------------------------+ -| :ref:`waveshare_lcd_modules` | |Waveshare 2.4 LCD| | ``waveshare_2_4_lcd`` | -+------------------------------------------+------------------------------------------+----------------------------------------+ -| :ref:`waveshare_pico_10dof_imu_sensor` | |Waveshare Pico 10-DOF IMU Sensor| | ``waveshare_pico_10dof_imu_sensor_r2`` | -| | +----------------------------------------+ -| | | ``waveshare_pico_10dof_imu_sensor_r1`` | -+------------------------------------------+------------------------------------------+----------------------------------------+ -| :ref:`waveshare_pico_environment_sensor` | |Waveshare Pico Environment Sensor| | ``waveshare_pico_environment_sensor`` | -+------------------------------------------+------------------------------------------+----------------------------------------+ ++------------------------------------------+-------------------------------------+----------------------------------------+ +| Hardware platform | Shield name | Build target | ++==========================================+=====================================+========================================+ +| Common for testing | :ref:`loopback_test_shield` | | ``loopback_test`` | +| | | | ``loopback_test_tmph`` | ++------------------------------------------+-------------------------------------+----------------------------------------+ +| Common for (new) chip support | :ref:`sc16is75x_bb_shield` | | ``cjmcu_750_i2c`` | +| | | | ``cjmcu_750_i2c_noirq`` | +| - NXP_ SC16IS750_ | | | ``cjmcu_750_spi`` | +| - NXP_ SC16IS752_ | | | ``cjmcu_750_spi_noirq`` | +| - NXP_ SC18IS604_ | | | ``cjmcu_752_i2c`` | +| | | | ``cjmcu_752_i2c_noirq`` | +| | | | ``cjmcu_752_spi`` | +| | | | ``cjmcu_752_spi_noirq`` | +| +-------------------------------------+----------------------------------------+ +| | :ref:`x_cjmcu_75x_shield` | ``x_cjmcu_75x`` | +| +-------------------------------------+----------------------------------------+ +| | :ref:`nxp_sc18is604_evb_shield` | ``nxp_sc18is604_evb`` | +| +-------------------------------------+----------------------------------------+ +| | :ref:`x_nxp_sc18is604_evb_shield` | ``x_nxp_sc18is604_evb`` | +| +-------------------------------------+----------------------------------------+ +| | :ref:`tcs_604_ard_shield` | | ``tcs_604_ard`` | +| | | | ``tcs_604_x_grove_testbed`` | ++------------------------------------------+-------------------------------------+----------------------------------------+ +| :ref:`grove_shield` | :ref:`grove_base_shield_v2` | ``seeed_grove_base_v2`` | +| +-------------------------------------+----------------------------------------+ +| | :ref:`grove_base_shield_v1` | ``seeed_grove_base_v1`` | +| +-------------------------------------+----------------------------------------+ +| | :ref:`grove_base_shield_xiao_v1` | ``seeed_grove_xiao_v1`` | +| +-------------------------------------+----------------------------------------+ +| | :ref:`grove_rpipico_shield_v1` | ``seeed_grove_rpipico_v1`` | +| +-------------------------------------+----------------------------------------+ +| | :ref:`grove_button_shield` | ``grove_btn_d[0…31]`` | +| +-------------------------------------+----------------------------------------+ +| | :ref:`grove_led_shield` | ``grove_led_d[0…31]`` | +| +-------------------------------------+----------------------------------------+ +| | :ref:`grove_sensor_shield` | | ``grove_sens_bme280`` | +| | | | ``grove_sens_bmp280`` | +| | | | ``grove_sens_dps310`` | +| +-------------------------------------+----------------------------------------+ +| | :ref:`x_grove_testbed_shield` | ``x_grove_testbed`` | ++------------------------------------------+-------------------------------------+----------------------------------------+ +| :ref:`rpi_pico_bb_shield` | |GeeekPi Pico Breadboard Kit| | ``geeekpi_pico_bb`` | +| +-------------------------------------+----------------------------------------+ +| | |GeeekPi Pico Breadboard Kit Plus| | ``geeekpi_pico_bb_plus`` | ++------------------------------------------+-------------------------------------+----------------------------------------+ +| :ref:`rpi_pico_clock_shield` | |Waveshare Pico Clock Green| | ``waveshare_pico_clock_green`` | ++------------------------------------------+-------------------------------------+----------------------------------------+ +| :ref:`rpi_pico_lcd_shield` | |PiMoroni Pico LCD 1.44| | ``pimoroni_pico_lcd_1_44`` | +| +-------------------------------------+----------------------------------------+ +| | |PiMoroni Pico LCD 2| | ``pimoroni_pico_lcd_2`` | +| +-------------------------------------+----------------------------------------+ +| | |Spotpear Pico LCD 1.54| | ``spotpear_pico_lcd_1_54`` | +| +-------------------------------------+----------------------------------------+ +| | |Waveshare Pico LCD 0.96| | ``waveshare_pico_lcd_0_96`` | +| +-------------------------------------+----------------------------------------+ +| | |Waveshare Pico LCD 1.14| | ``waveshare_pico_lcd_1_14`` | +| +-------------------------------------+----------------------------------------+ +| | |Waveshare Pico LCD 1.3| | ``waveshare_pico_lcd_1_3`` | +| +-------------------------------------+----------------------------------------+ +| | |Waveshare Pico LCD 1.44| | ``waveshare_pico_lcd_1_44`` | +| +-------------------------------------+----------------------------------------+ +| | |Waveshare Pico LCD 1.8| | ``waveshare_pico_lcd_1_8`` | +| +-------------------------------------+----------------------------------------+ +| | |Waveshare Pico LCD 2| | ``waveshare_pico_lcd_2`` | +| +-------------------------------------+----------------------------------------+ +| | |Waveshare Pico ResTouch LCD 2.8| | ``waveshare_pico_restouch_lcd_2_8`` | +| +-------------------------------------+----------------------------------------+ +| | |Waveshare Pico ResTouch LCD 3.5| | ``waveshare_pico_restouch_lcd_3_5`` | ++------------------------------------------+-------------------------------------+----------------------------------------+ +| :ref:`rpi_pico_led_shield` | |Waveshare Pico RGB LED| | ``waveshare_pico_rgb_led`` | ++------------------------------------------+-------------------------------------+----------------------------------------+ +| :ref:`rpi_pico_test_shield` | |Spotpear Pico ALL GPIO TEST| | ``spotpear_pico_test`` | ++------------------------------------------+-------------------------------------+----------------------------------------+ +| :ref:`waveshare_lcd_modules` | |Waveshare 2.4 LCD| | ``waveshare_2_4_lcd`` | ++------------------------------------------+-------------------------------------+----------------------------------------+ +| :ref:`waveshare_pico_10dof_imu_sensor` | |Waveshare Pico 10-DOF IMU Sensor| | ``waveshare_pico_10dof_imu_sensor_r2`` | +| | +----------------------------------------+ +| | | ``waveshare_pico_10dof_imu_sensor_r1`` | ++------------------------------------------+-------------------------------------+----------------------------------------+ +| :ref:`waveshare_pico_environment_sensor` | |Waveshare Pico Environment Sensor| | ``waveshare_pico_environment_sensor`` | ++------------------------------------------+-------------------------------------+----------------------------------------+ +Snippet names +************* + +The following tables list all snippets and build targets for |TIAC| +hardware platforms. + Snippets included in tiac-bridle ================================ The following snippets are defined in the :file:`bridle/snippets/` folder. Also see the :ref:`snippets` section in this documentation. -+---------------------+----------------------------------+-----------------------------+ -| Hardware platform | Snippet name | Build target | -+=====================+==================================+=============================+ -| Common for usage | :ref:`snippet-usb-console` | ``usb-console`` | -+---------------------+----------------------------------+-----------------------------+ -| Common for usage | :ref:`snippet-pwm-servo` | ``pwm-servo`` | -+---------------------+----------------------------------+-----------------------------+ -| Common for testing | :ref:`snippet-can-timing-adj` | ``can-timing-adj`` | -+---------------------+----------------------------------+-----------------------------+ ++---------------------+---------------------------------------------+----------------------------------+ +| Hardware platform | Snippet name | Build target | ++=====================+=============================================+==================================+ +| Common for usage | :ref:`snippet-del-default-aliases` | ``del-default-aliases`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Common for usage | :ref:`snippet-usb-console` | ``usb-console`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Common for usage | :ref:`snippet-pwm-servo` | ``pwm-servo`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Common for testing | :ref:`snippet-can-timing-adj` | ``can-timing-adj`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Common for testing | :ref:`snippet-wdt-timing-adj` | ``wdt-timing-adj`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Common for testing | :ref:`snippet-tstdrv-bldall-display-adj` | ``tstdrv-bldall-display-adj`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Common for testing | :ref:`snippet-tstdrv-bldall-gpio-adj` | ``tstdrv-bldall-gpio-adj`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Common for testing | :ref:`snippet-tstdrv-bldall-i2c-adj` | ``tstdrv-bldall-i2c-adj`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Common for testing | :ref:`snippet-tstdrv-bldall-mfd-adj` | ``tstdrv-bldall-mfd-adj`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Common for testing | :ref:`snippet-tstdrv-bldall-rtc-adj` | ``tstdrv-bldall-rtc-adj`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Common for testing | :ref:`snippet-tstdrv-bldall-sensor-adj` | ``tstdrv-bldall-sensor-adj`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Common for testing | :ref:`snippet-tstdrv-bldall-uart-adj` | ``tstdrv-bldall-uart-adj`` | ++---------------------+---------------------------------------------+----------------------------------+ +| Tweak for setups | :ref:`snippet-samples-sensor-bme280-tweaks` | ``samples-sensor-bme280-tweaks`` | ++---------------------+---------------------------------------------+----------------------------------+ -Custom boards -************* +Custom boards and shields +************************* -Defining your own board is a very common step in application development, -since applications are typically designed to run on boards that are not -directly supported by |BRIDLE|, given that they are typically custom -designs and not available publicly. To define your own board, you can -use the following Zephyr guides as reference, since boards are defined -in the |BRIDLE| just as they are in Zephyr: +Defining your own board or shield is a very common step in application +development, since applications are typically designed to run on boards +that are not directly supported by |ZEPHYR| or |BRIDLE|, given that they +are typically custom designs and not available publicly. To define your +own board or shield, you can use the following |ZEPHYR| guides as reference, +since boards are defined in |BRIDLE| just as they are in the |ZEPHYR|: * :ref:`zephyr:custom_board_definition` is a guide to adding your own custom board to the Zephyr build system. +* :ref:`zephyr:shields` + is a complete guide to integrate your own modules as shields. * :ref:`zephyr:board_porting_guide` is a complete guide to porting Zephyr to your own board. +* :ref:`zephyr:soc_porting_guide` + is a complete guide to porting Zephyr to your own SoC. +* :ref:`zephyr:architecture_porting_guide` + is a complete guide to porting Zephyr to your own architecture. diff --git a/doc/bridle/app_build_system.rst b/doc/bridle/app_build_system.rst index 41ac7511e7..fd42f32a07 100644 --- a/doc/bridle/app_build_system.rst +++ b/doc/bridle/app_build_system.rst @@ -7,8 +7,8 @@ Build and configuration system :local: :depth: 2 -The |BRIDLE| build and configuration system is based on the one from Zephyr, -with some additions. +The |BRIDLE| build and configuration system is based on the one from the +|ZEPHYR|, with some additions. Zephyr's build and configuration system *************************************** @@ -21,10 +21,10 @@ as a foundation: * Devicetree, a hardware description language that is used to describe the hardware that |BRIDLE| is to run on. -Since the build and configuration system used by |BRIDLE| comes from Zephyr, -references to the original Zephyr documentation are provided here in order to -avoid duplication. See the following links for information about the different -building blocks mentioned above: +Since the build and configuration system used by |BRIDLE| comes from the +|ZEPHYR|, references to the original |ZEPHYR| documentation are provided here +in order to avoid duplication. See the following links for information about +the different building blocks mentioned above: * :ref:`zephyr:application` is a complete guide to application development with Zephyr, including the build and configuration system. @@ -38,23 +38,29 @@ building blocks mentioned above: |BRIDLE| additions ****************** -|BRIDLE| adds some functionality on top of the Zephyr build and configuration -system. Those additions are automatically included into the Zephyr build system -using a :ref:`zephyr:cmake_build_config_package`. +|BRIDLE| adds some functionality on top of the |ZEPHYR| build and configuration +system. Those additions are automatically included into the |ZEPHYR| build +system using a :ref:`zephyr:cmake_build_config_package`. You must be aware of these additions when you start writing your own Bridle applications. -* The |BRIDLE| provides an additional :file:`boilerplate.cmake` that - is automatically included when using the Zephyr CMake package in the +* |BRIDLE| provides an additional set of :file:`*.cmake` module files that + are automatically included when using the |ZEPHYR| CMake package in the :file:`CMakeLists.txt` file of your application:: - find_package(Zephyr HINTS $ENV{ZEPHYR_BASE}) + find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE}) -* The |BRIDLE| allows you to + Also it is possible and the **default use case** to using the + Bridle CMake package (that automatically includes the |ZEPHYR|) + in the :file:`CMakeLists.txt` file of your application:: + + find_package(Bridle REQUIRED HINTS $ENV{BRIDLE_BASE}) + +* |BRIDLE| allows you to :ref:`create custom build type files ` instead of using a single :file:`prj.conf` file. .. * The |BRIDLE| build system extends Zephyr's with support for multi-image builds. .. You can find out more about these in the :ref:`ug_multi_image` section. -.. * The |BRIDLE| adds a partition manager, responsible for partitioning the available flash memory. +.. * |BRIDLE| adds a partition manager, responsible for partitioning the available flash memory. diff --git a/doc/bridle/dm_code_base.rst b/doc/bridle/dm_code_base.rst index 4d5c63d1cb..f1ad30ee03 100644 --- a/doc/bridle/dm_code_base.rst +++ b/doc/bridle/dm_code_base.rst @@ -94,9 +94,9 @@ Repository structure ******************** In order to manage the combination of repositories and versions, |BRIDLE| uses -:ref:`west `, the same tool that Zephyr uses to manage its +:ref:`west `, the same tool that the |ZEPHYR| uses to manage its repository set. You can learn more about the reasons behind the introduction of -west in :ref:`this section ` of the Zephyr documentation. +west in :ref:`this section ` of the |ZEPHYR| documentation. A :ref:`manifest repository `, `tiac-bridle`_, contains a file in its root folder, :file:`west.yml`, which lists all other repositories @@ -130,7 +130,7 @@ repository, updating it with Git regularly and using ``west update`` to update the project repositories every time the manifest repository changes. More information about manifests can be found in the :ref:`west manifest section ` -of the Zephyr documentation. +of the |ZEPHYR| documentation. Revisions ********* @@ -189,23 +189,25 @@ repositories distributed with |BRIDLE|. This section describes how the history of these OSS repositories is maintained, and how they are synchronized with their upstreams. -The short logs for these downstream patches contain ``[bridle xyz]`` at the +The short logs for these downstream patches contain ``[tcs xyz]`` at the beginning, for different ``xyz`` strings. This makes their different purposes downstream clearer, and makes them easier to search for and see in ``git log``. -The current values of ``[bridle xyz]`` are: +The current values of ``[tcs xyz]`` are: -* ``[bridle mergeup]``: +* ``[tcs mergeup]``: periodic merges of the upstream tree (if really needed) -* ``[bridle fromlist]``: +* ``[tcs fromlist]``: patches which have upstream pull requests, including any later revisions -* ``[bridle toup]``: +* ``[tcs fromtree]``: + patches which have been cherry-picked from an upstream tree +* ``[tcs toup]``: patches which |TIAC| developers intend to submit upstream later -* ``[bridle noup]``: +* ``[tcs noup]``: patches which are specific to |BRIDLE| -* ``[bridle temphack]``: +* ``[tcs temphack]``: temporary patches with some known issues -* ``[bridle fromtree]``: - patches which have been cherry-picked from an upstream tree +* ``[backport-]``: + patches which have been cherry-picked from an upstream backport pull request .. note:: diff --git a/doc/bridle/shortcuts.txt b/doc/bridle/shortcuts.txt index 8bbdae86fd..ae72872fb3 100644 --- a/doc/bridle/shortcuts.txt +++ b/doc/bridle/shortcuts.txt @@ -1,5 +1,6 @@ .. |TIAC| replace:: TiaC Systems .. |BRIDLE| replace:: Bridle +.. |ZEPHYR| replace:: Zephyr Project .. External References (temporary, needs local implementation) diff --git a/doc/bridle/ug_west_meta_tool.rst b/doc/bridle/ug_west_meta_tool.rst index a656767160..5a442cd2c2 100644 --- a/doc/bridle/ug_west_meta_tool.rst +++ b/doc/bridle/ug_west_meta_tool.rst @@ -6,11 +6,10 @@ West (Zephyr’s meta-tool) In European tradition, a |zephyr|_ is a light wind or a |west wind|_, named after |Zephyrus|_, the Greek god or personification of the west wind. Don't worry, this is not going to be a lesson in Greek methodology. Rather, it is -an attempt to find a "possible" explanation why the Zephyr project in so many -cases refers to and relies on a small, inconspicuous but essential meta-tool -called ``west``\ [#west-repo]_. What this meta-tool is capable of doing can -be read in detail at section :ref:`west ` in the Zephyr project -documentation. +an attempt to find a "possible" explanation why the |ZEPHYR| in so many cases +refers to and relies on a small, inconspicuous but essential meta-tool called +``west``\ [#west-repo]_. What this meta-tool is capable of doing can be read +in detail at section :ref:`west ` in the |ZEPHYR| documentation. .. |zephyr| replace:: :strong:`zephyr` .. _zephyr: https://en.wikipedia.org/wiki/Zephyr