From b439b999316f62b2ae9d1ae0a296425a7ed70460 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Fri, 17 May 2024 11:49:29 -0600 Subject: doc: process.rst: Use subsubheading for "Phases of the Development Process" These sections which talk about the different phases of the development process should be using the subsubheading identifier. Signed-off-by: Tom Rini Reviewed-by: Quentin Schulz --- doc/develop/process.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/develop') diff --git a/doc/develop/process.rst b/doc/develop/process.rst index 92477d05dd8..a66540a698c 100644 --- a/doc/develop/process.rst +++ b/doc/develop/process.rst @@ -34,7 +34,7 @@ It is followed by a *Stabilization Period*. The end of a Release Cycle is marked by the release of a new U-Boot version. Merge Window ------------- +^^^^^^^^^^^^ The Merge Window is the period when new patches get submitted (and hopefully accepted) for inclusion into U-Boot mainline. This period lasts for 21 days (3 @@ -44,7 +44,7 @@ This is the only time when new code (like support for new processors or new boards, or other new features or reorganization of code) is accepted. Twilight Time -------------- +^^^^^^^^^^^^^ Usually patches do not get accepted as they are - the peer review that takes place will usually require changes and resubmissions of the patches before they @@ -65,13 +65,13 @@ the Merge Window does not preclude patches that were already posted from being merged for the upcoming release. Stabilization Period --------------------- +^^^^^^^^^^^^^^^^^^^^ During the Stabilization Period only patches containing bug fixes get applied. Corner Cases ------------- +^^^^^^^^^^^^ Sometimes it is not clear if a patch contains a bug fix or not. For example, changes that remove dead code, unused macros etc. or -- cgit v1.3.1 From 0efc5a9f670144cad7f287711f25c69cba0fde39 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Fri, 17 May 2024 11:49:30 -0600 Subject: doc: process.rst: Document device tree resync rules Document the logic of when we do a full resync of the device trees used by OF_UPSTREAM as well as that cherry-picking is allowed as needed. Signed-off-by: Tom Rini Reviewed-by: Quentin Schulz --- doc/develop/devicetree/control.rst | 9 ++++++--- doc/develop/process.rst | 13 +++++++++++++ 2 files changed, 19 insertions(+), 3 deletions(-) (limited to 'doc/develop') diff --git a/doc/develop/devicetree/control.rst b/doc/develop/devicetree/control.rst index 4cc1457d4ea..ca4fb0b5b10 100644 --- a/doc/develop/devicetree/control.rst +++ b/doc/develop/devicetree/control.rst @@ -113,9 +113,12 @@ SoC being used via Kconfig and set `DEFAULT_DEVICE_TREE=/` when prompted by Kconfig. However, if `dts/upstream/` hasn't yet received devicetree source file for your -newly added board support then you can add corresponding devicetree source file -as `arch//dts/.dts`. To select that add `# CONFIG_OF_UPSTREAM is not -set` and set `DEFAULT_DEVICE_TREE=` when prompted by Kconfig. +newly added board support then one option is that you can add the corresponding +devicetree source file as `arch//dts/.dts`. To select that add `# +CONFIG_OF_UPSTREAM is not set` and set `DEFAULT_DEVICE_TREE=` when +prompted by Kconfig. Another option is that you can use use the "pick" option of +`dts/update-dts-subtree.sh` mentioned above to bring in the commits that you +need. This should include your CPU or SoC's devicetree file. On top of that any U-Boot specific tweaks (see: :ref:`dttweaks`) can be made for your board. diff --git a/doc/develop/process.rst b/doc/develop/process.rst index a66540a698c..0542b3fc124 100644 --- a/doc/develop/process.rst +++ b/doc/develop/process.rst @@ -108,6 +108,19 @@ Differences to the Linux Development Process In U-Boot, ``"-rc1"`` will only be released after all (or at least most of the) patches that were submitted during the merge window have been applied. +Resyncing of the device tree subtree +------------------------------------ + +As explained in :doc:`devicetree/control` some platforms make use of device tree +files which come from a git subtree that mirrors the Linux Kernel sources +itself. For our purposes, we only track releases and not release candidates for +merging in our tree. These merges follow the normal merge window rules. + +In the case of specific changes, such as bug fixes or new platform support, +these can be "cherry-picked" and are subject to the normal merge rules. For +example, a bug fix can come in later in the window but a full re-sync only +happens within the merge window itself. + .. _custodians: Custodians -- cgit v1.3.1 From dfb28817c10e9b446832e2b4149bb6b874251fbc Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Tue, 18 Jun 2024 08:16:44 +0200 Subject: doc: FIT links in develop/uefi/uefi.rst Correct the links to the FIT documentation. Signed-off-by: Heinrich Schuchardt Reviewed-by: Ilias Apalodimas --- doc/develop/uefi/uefi.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/develop') diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst index 0389b269c01..ea70dcbda86 100644 --- a/doc/develop/uefi/uefi.rst +++ b/doc/develop/uefi/uefi.rst @@ -72,7 +72,7 @@ bootm command. This feature is available if U-Boot is configured with:: CONFIG_BOOTM_EFI=y -A sample configuration is provided as file doc/uImage.FIT/uefi.its. +A sample configuration is provided in :doc:`../../usage/fit/uefi`. Below you find the output of an example session starting GRUB:: @@ -96,7 +96,7 @@ Below you find the output of an example session starting GRUB:: ## Transferring control to EFI (at address 404000d0) ... Welcome to GRUB! -See doc/uImage.FIT/howto.txt for an introduction to FIT images. +See :doc:`../../usage/fit/howto` for an introduction to FIT images. Configuring UEFI secure boot ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.3.1 From 7ec3b48908750edd3d7b86236a614313c1b67120 Mon Sep 17 00:00:00 2001 From: Alexander Dahl Date: Fri, 21 Jun 2024 09:47:19 +0200 Subject: doc: develop: testing: Fix broken reference to pytest suite help This should have been adapted directly with or after v2021.01-693-gca6583d4e08 ("doc: move test/README to HTML documentation") or v2021.01-694-g0157619d5c8 ("doc: move test/py/README.md to HTML documentation") already. Signed-off-by: Alexander Dahl Reviewed-by: Simon Glass --- doc/develop/testing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/develop') diff --git a/doc/develop/testing.rst b/doc/develop/testing.rst index 5afeb42f696..056bdfd2b69 100644 --- a/doc/develop/testing.rst +++ b/doc/develop/testing.rst @@ -69,7 +69,7 @@ build:: ./test/py/test.py --bd sandbox_spl --build -k test_spl -See test/py/README.md for more information about the pytest suite. +See :doc:`py_testing` for more information about the pytest suite. See :doc:`tests_sandbox` for how to run tests directly (not through pytest). -- cgit v1.3.1 From 7a8bd3fa316153ab875c1b5d0e9bdfd55337c2db Mon Sep 17 00:00:00 2001 From: Alexander Dahl Date: Fri, 21 Jun 2024 09:47:20 +0200 Subject: doc: develop: testing: Fix reference to test writing section Add missing colon in :doc: link. Fixes: fc3283314539 ("doc: Explain briefly how to write new tests") Signed-off-by: Alexander Dahl Reviewed-by: Simon Glass --- doc/develop/testing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/develop') diff --git a/doc/develop/testing.rst b/doc/develop/testing.rst index 056bdfd2b69..9114d11ad26 100644 --- a/doc/develop/testing.rst +++ b/doc/develop/testing.rst @@ -123,7 +123,7 @@ or is covered sparingly. So here are some suggestions: is much easier to add onto a test - writing a new large test can seem daunting to most contributors. -See doc:`tests_writing` for how to write tests. +See :doc:`tests_writing` for how to write tests. Future work -- cgit v1.3.1 From 9e9f78f7aa0124ef0e622532043acf87e84008dc Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Mon, 24 Jun 2024 13:29:32 -0600 Subject: Prepare v2024.07-rc5 Signed-off-by: Tom Rini --- Makefile | 2 +- doc/develop/release_cycle.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/develop') diff --git a/Makefile b/Makefile index f8206b2e30a..b5f7ecb86a5 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ VERSION = 2024 PATCHLEVEL = 07 SUBLEVEL = -EXTRAVERSION = -rc4 +EXTRAVERSION = -rc5 NAME = # *DOCUMENTATION* diff --git a/doc/develop/release_cycle.rst b/doc/develop/release_cycle.rst index c9fb07f59e1..b392346eea8 100644 --- a/doc/develop/release_cycle.rst +++ b/doc/develop/release_cycle.rst @@ -75,7 +75,7 @@ For the next scheduled release, release candidates were made on:: * U-Boot v2024.07-rc4 was released on Mon 03 June 2024. -.. * U-Boot v2024.07-rc5 was released on Mon 17 June 2024. +* U-Boot v2024.07-rc5 was released on Mon 24 June 2024. Please note that the following dates are planned only and may be deviated from as needed. -- cgit v1.3.1