Skip to content

Commit 19e6fb3

Browse files
FrancescoSerrlubos
authored andcommitted
doc: Updated documentation with PM deprecation note.
Updated documentation with PM deprecation note. Signed-off-by: Francesco Domenico Servidio <francesco.servidio@nordicsemi.no>
1 parent c9e88e0 commit 19e6fb3

14 files changed

Lines changed: 29 additions & 0 deletions

File tree

doc/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ The |NCS| currently supports two implementations:
6767
.. figure:: ../images/bootloader_memory_layout.svg
6868
:alt: Memory layout
6969

70+
.. include:: ../../../includes/pm_deprecation.txt
71+
7072
By default, building an application with any bootloader configuration uses :ref:`sysbuild` to build multiple image, where the :ref:`partition_manager` manages its memory partitions.
7173
When building an application with :ref:`Cortex-M Security Extensions (CMSE) enabled <app_boards_spe_nspe_cpuapp_ns>`, then :ref:`Trusted Firmware-M (TF-M) <ug_tfm>` is built with the image automatically.
7274
From the bootloader perspective, the TF-M is part of the booted application image.

doc/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_partitioning.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Partitioning device memory is a crucial aspect of managing how a device's storag
1111
By default, the Partition Manager in the system dynamically generates a partition map, which is suitable for most applications that do not use Device Firmware Upgrades (DFU).
1212
For scenarios involving DFU, read the following sections.
1313

14+
.. include:: ../../../includes/pm_deprecation.txt
15+
1416
.. _bootloader_partitioning_partitions_file:
1517

1618
Partition map file

doc/nrf/app_dev/bootloaders_dfu/qspi_xip_split_image.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ The QSPI XIP split image feature supports network core image updates on nRF5340
5252
Create the Partition Manager static files
5353
*****************************************
5454

55+
.. include:: ../../includes/pm_deprecation.txt
56+
5557
Create the following files:
5658

5759
* A static :ref:`partition_manager` file to set up the partitions that will be used on the device.

doc/nrf/app_dev/config_and_build/cmake/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ The |NCS| uses the same CMake build variables as Zephyr and they are compatible
5656
|parameters_override_west_config|
5757

5858
For the complete list of build variables in Zephyr and more information about them, see :ref:`zephyr:important-build-vars` in the Zephyr documentation.
59+
60+
.. include:: ../../../includes/pm_deprecation.txt
61+
5962
The following table lists the most common ones used in the |NCS|:
6063

6164
.. list-table:: Common build system variables in the |NCS|

doc/nrf/app_dev/config_and_build/config_and_build_system.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,8 @@ The :ref:`Kconfig Reference <configuration_options>` provides the documentation
133133
Memory layout configuration
134134
---------------------------
135135

136+
.. include:: ../../includes/pm_deprecation.txt
137+
136138
The memory layout configuration is provided by the :ref:`partition_manager` script, specific to the |NCS|.
137139

138140
The script must be enabled to provide the memory layout configuration.

doc/nrf/app_dev/config_and_build/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ All of them have a role in the creation of an application, from configuring the
2424
* Ninja (comparable to Make) uses the build files to build the program.
2525
* The compiler (for example, GCC) creates the executables.
2626

27+
.. include:: ../../includes/pm_deprecation.txt
28+
2729
For a more detailed overview, see :ref:`app_build_system`.
2830

2931
Depending on the board you are working with, check also its :ref:`hardware guide <device_guides>`, as some nRF Series families have specific exceptions and rules to be applied on top of the general configuration procedures.

doc/nrf/app_dev/config_and_build/sysbuild/sysbuild_forced_options.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Sysbuild controls some Kconfig options in images that are part of a project.
77
This means that these Kconfig options can only be changed from within sysbuild itself and cannot be changed directly in an image.
88
Trying to change them directly in an image will result in the new value being overwritten with the sysbuild value.
99

10+
.. include:: ../../../includes/pm_deprecation.txt
11+
1012
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+-------------------------+
1113
| Kconfig | Sysbuild Kconfig | Images |
1214
+=========================================================================+===========================================================================+=========================+

doc/nrf/app_dev/config_and_build/sysbuild/sysbuild_images.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ These options specify the image for the firmware loader:
6565
Adding custom images
6666
********************
6767

68+
.. include:: ../../../includes/pm_deprecation.txt
69+
6870
Custom images can be added directly to a project (or board) or to a Zephyr module, making them accessible to multiple projects.
6971

7072
.. _sysbuild_images_adding_to_single_project:

doc/nrf/app_dev/data_storage.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,8 @@ See the following sections for descriptions of the storage features from the tab
9898
Partitioning
9999
------------
100100

101+
.. include:: ../includes/pm_deprecation.txt
102+
101103
Partitioning prevents storage subsystems from overwriting each other's data by giving them ownership over different non-volatile memory regions.
102104
In the |NCS|, you can use either :ref:`Devicetree fixed flash partitions <zephyr:flash_map_api>` or the :ref:`Partition Manager <partition_manager>` to manage non-volatile memory partitions.
103105

doc/nrf/app_dev/device_guides/nrf53/qspi_xip_guide_nrf5340.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ Add the following to the DTS overlay for your board:
108108
Setting up static partition manager
109109
***********************************
110110

111+
.. include:: ../../../includes/pm_deprecation.txt
112+
111113
You need to complete the setup in order to use a static partitioning in your project.
112114
The configuration must have 3 images with 2 slots each:
113115

0 commit comments

Comments
 (0)