diff options
author | Tom Rini <trini@konsulko.com> | 2024-05-20 10:16:33 -0600 |
---|---|---|
committer | Tom Rini <trini@konsulko.com> | 2024-05-20 10:16:33 -0600 |
commit | d4781422d1268aa6deca3e49d2fb227e79c160b4 (patch) | |
tree | 420073c8a29a401a3908803000df6f54673e1731 /doc/develop | |
parent | 85854bc3324edd0c81047780ee60033d056fd490 (diff) | |
parent | a7f0154c412859323396111dd0c09dbafbc153cb (diff) |
Merge tag 'v2024.07-rc3' into next
Prepare v2024.07-rc3
Diffstat (limited to 'doc/develop')
-rw-r--r-- | doc/develop/codingstyle.rst | 8 | ||||
-rw-r--r-- | doc/develop/release_cycle.rst | 2 | ||||
-rw-r--r-- | doc/develop/tests_writing.rst | 1 |
3 files changed, 8 insertions, 3 deletions
diff --git a/doc/develop/codingstyle.rst b/doc/develop/codingstyle.rst index fa3cd6aec82..f6248cdcb1e 100644 --- a/doc/develop/codingstyle.rst +++ b/doc/develop/codingstyle.rst @@ -110,8 +110,9 @@ Include files You should follow this ordering in U-Boot. In all cases, they should be listed in alphabetical order. First comes headers which are located directly in our -top-level include diretory. Second are headers within subdirectories, Finally -directory-local includes should be listed. See this example: +top-level include diretory. This excludes the common.h header file which is to +be removed. Second are headers within subdirectories, Finally directory-local +includes should be listed. See this example: .. code-block:: C @@ -128,6 +129,9 @@ For files that need to be compiled for the host (e.g. tools), you need to use ``#ifndef USE_HOSTCC`` to avoid including U-Boot specific include files. See common/image.c for an example. +If you encounter code which still uses <common.h> a patch to remove that and +replace it with any required include files directly is much appreciated. + If your file uses driver model, include <dm.h> in the C file. Do not include dm.h in a header file. Try to use forward declarations (e.g. ``struct udevice``) instead. diff --git a/doc/develop/release_cycle.rst b/doc/develop/release_cycle.rst index 64757b4df18..383f4480c6e 100644 --- a/doc/develop/release_cycle.rst +++ b/doc/develop/release_cycle.rst @@ -71,7 +71,7 @@ For the next scheduled release, release candidates were made on:: * U-Boot v2024.07-rc2 was released on Mon 06 May 2024. -.. * U-Boot v2024.07-rc3 was released on Mon 20 May 2024. +* U-Boot v2024.07-rc3 was released on Mon 20 May 2024. .. * U-Boot v2024.07-rc4 was released on Mon 03 June 2024. diff --git a/doc/develop/tests_writing.rst b/doc/develop/tests_writing.rst index 44b544fa78b..bb1145da268 100644 --- a/doc/develop/tests_writing.rst +++ b/doc/develop/tests_writing.rst @@ -281,6 +281,7 @@ new one of those, you should add a new suite. Create a new file in test/ or a subdirectory and define a macro to register the suite. For example:: + #include <common.h> #include <console.h> #include <mapmem.h> #include <dm/test.h> |