summaryrefslogtreecommitdiff
path: root/doc/develop
diff options
context:
space:
mode:
Diffstat (limited to 'doc/develop')
-rw-r--r--doc/develop/bootstd/overview.rst8
-rw-r--r--doc/develop/coccinelle.rst10
-rw-r--r--doc/develop/distro.rst8
-rw-r--r--doc/develop/driver-model/fs_firmware_loader.rst2
-rw-r--r--doc/develop/driver-model/serial-howto.rst4
-rw-r--r--doc/develop/driver-model/virtio.rst2
-rw-r--r--doc/develop/process.rst2
-rw-r--r--doc/develop/pytest/test_fit_verity_sign.rst10
-rw-r--r--doc/develop/pytest/usage.rst2
-rw-r--r--doc/develop/release_cycle.rst14
-rw-r--r--doc/develop/security.rst2
-rw-r--r--doc/develop/sending_patches.rst41
-rw-r--r--doc/develop/tests_writing.rst4
-rw-r--r--doc/develop/uefi/iscsi.rst6
-rw-r--r--doc/develop/uefi/u-boot_on_efi.rst4
-rw-r--r--doc/develop/uefi/uefi.rst14
16 files changed, 66 insertions, 67 deletions
diff --git a/doc/develop/bootstd/overview.rst b/doc/develop/bootstd/overview.rst
index 397f6db18b4..cf8ef419d4b 100644
--- a/doc/develop/bootstd/overview.rst
+++ b/doc/develop/bootstd/overview.rst
@@ -152,7 +152,7 @@ boot_targets
This environment variable can be used to control the list of bootdevs searched
and their ordering, for example::
- setenv boot_targets "mmc0 mmc1 usb pxe"
+ env set boot_targets "mmc0 mmc1 usb pxe"
Entries may be removed or re-ordered in this list to affect the boot order. If
the variable is empty, the default ordering is used, based on the priority of
@@ -169,7 +169,7 @@ used by the old distro scripts.
This environment variable can be used to control the list of bootmeths used and
their ordering for example::
- setenv bootmeths "extlinux efi"
+ env set bootmeths "extlinux efi"
Entries may be removed or re-ordered in this list to affect the order the
bootmeths are tried on each bootdev. If the variable is empty, the default
@@ -882,7 +882,7 @@ Other ideas:
.. _distro_bootcmd: https://github.com/u-boot/u-boot/blob/master/include/config_distro_bootcmd.h
-.. _BootLoaderSpec: http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/
-.. _distro_boot: https://github.com/u-boot/u-boot/blob/master/boot/distro.c
+.. _BootLoaderSpec: https://uapi-group.org/specifications/specs/boot_loader_specification/
+.. _distro_boot: https://github.com/u-boot/u-boot/blob/v2023.04/boot/bootmeth_distro.c
.. _bootflow_h: https://github.com/u-boot/u-boot/blob/master/include/bootflow.h
.. _migrate_patch: https://patchwork.ozlabs.org/project/uboot/patch/[email protected]/
diff --git a/doc/develop/coccinelle.rst b/doc/develop/coccinelle.rst
index 70274c3f5f5..d0ad803fc7b 100644
--- a/doc/develop/coccinelle.rst
+++ b/doc/develop/coccinelle.rst
@@ -34,7 +34,7 @@ of many distributions, e.g. :
Some distribution packages are obsolete and it is recommended
to use the latest version released from the Coccinelle homepage at
-http://coccinelle.lip6.fr/
+https://coccinelle.gitlabpages.inria.fr/website/
Or from Github at:
@@ -58,15 +58,9 @@ https://github.com/coccinelle/coccinelle/blob/master/install.txt
Supplemental documentation
--------------------------
-For supplemental documentation refer to the wiki:
-
-https://bottest.wiki.kernel.org/coccicheck
-
-The wiki documentation always refers to the linux-next version of the script.
-
For Semantic Patch Language(SmPL) grammar documentation refer to:
-http://coccinelle.lip6.fr/documentation.php
+https://coccinelle.gitlabpages.inria.fr/website/documentation.html
Using Coccinelle on the Linux kernel
------------------------------------
diff --git a/doc/develop/distro.rst b/doc/develop/distro.rst
index 01efce40a29..5e906750119 100644
--- a/doc/develop/distro.rst
+++ b/doc/develop/distro.rst
@@ -384,22 +384,22 @@ boot_scripts:
scan_dev_for_extlinux:
If you want to disable extlinux.conf on all disks, set the value to something
- innocuous, e.g. setenv scan_dev_for_extlinux true.
+ innocuous, e.g. env set scan_dev_for_extlinux true.
scan_dev_for_scripts:
If you want to disable boot.scr on all disks, set the value to something
- innocuous, e.g. setenv scan_dev_for_scripts true.
+ innocuous, e.g. env set scan_dev_for_scripts true.
boot_net_usb_start:
If you want to prevent USB enumeration by distro boot commands which execute
- network operations, set the value to something innocuous, e.g. setenv
+ network operations, set the value to something innocuous, e.g. env set
boot_net_usb_start true. This would be useful if you know your Ethernet
device is not attached to USB, and you wish to increase boot speed by
avoiding unnecessary actions.
boot_net_pci_enum:
If you want to prevent PCI enumeration by distro boot commands which execute
- network operations, set the value to something innocuous, e.g. setenv
+ network operations, set the value to something innocuous, e.g. env set
boot_net_pci_enum true. This would be useful if you know your Ethernet
device is not attached to PCI, and you wish to increase boot speed by
avoiding unnecessary actions.
diff --git a/doc/develop/driver-model/fs_firmware_loader.rst b/doc/develop/driver-model/fs_firmware_loader.rst
index 149b8b436ec..630daf636f1 100644
--- a/doc/develop/driver-model/fs_firmware_loader.rst
+++ b/doc/develop/driver-model/fs_firmware_loader.rst
@@ -6,7 +6,7 @@ File System Firmware Loader
This is file system firmware loader for U-Boot framework, which has very close
to some Linux Firmware API. For the details of Linux Firmware API, you can refer
-to https://01.org/linuxgraphics/gfx-docs/drm/driver-api/firmware/index.html.
+to https://docs.kernel.org/driver-api/firmware/index.html.
File system firmware loader can be used to load whatever(firmware, image,
and binary) from the storage device in file system format into target location
diff --git a/doc/develop/driver-model/serial-howto.rst b/doc/develop/driver-model/serial-howto.rst
index 17b53e3cabf..8ca9a016f9a 100644
--- a/doc/develop/driver-model/serial-howto.rst
+++ b/doc/develop/driver-model/serial-howto.rst
@@ -97,8 +97,8 @@ Here are some things you might need to consider:
uart2: uart2 {
uart2_xfer: uart2-xfer {
- rockchip,pins = <1 RK_PC2 RK_FUNC_2 &pcfg_pull_up>,
- <1 RK_PC3 RK_FUNC_2 &pcfg_pull_none>;
+ rockchip,pins = <1 RK_PC2 2 &pcfg_pull_up>,
+ <1 RK_PC3 2 &pcfg_pull_none>;
};
...
};
diff --git a/doc/develop/driver-model/virtio.rst b/doc/develop/driver-model/virtio.rst
index 9a5e3240c3c..e5da9f4301c 100644
--- a/doc/develop/driver-model/virtio.rst
+++ b/doc/develop/driver-model/virtio.rst
@@ -284,5 +284,5 @@ for the remove method to be called before jumping to OS.
6. do funny stuff with the driver
-.. _VirtIO: http://docs.oasis-open.org/virtio/virtio/v1.0/virtio-v1.0.pdf
+.. _VirtIO: https://docs.oasis-open.org/virtio/virtio/v1.0/virtio-v1.0.pdf
.. _QEMU: https://www.qemu.org
diff --git a/doc/develop/process.rst b/doc/develop/process.rst
index 3c783ed5a0e..8ade440d84b 100644
--- a/doc/develop/process.rst
+++ b/doc/develop/process.rst
@@ -236,7 +236,7 @@ Tooling
There are a number of tools available to help custodians and
contributors alike with their contributions. As a project we make use of
-the Patchwork project hosted at `OzLabs <http://patchwork.ozlabs.org/>`__
+the Patchwork project hosted at `OzLabs <https://patchwork.ozlabs.org/>`__
and more discussion on how it is used from both a contributor as well as
custodian point of view can be found :ref:`here <patchwork>`.
diff --git a/doc/develop/pytest/test_fit_verity_sign.rst b/doc/develop/pytest/test_fit_verity_sign.rst
new file mode 100644
index 00000000000..94a39b08952
--- /dev/null
+++ b/doc/develop/pytest/test_fit_verity_sign.rst
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+test_fit_verity_sign
+====================
+
+.. automodule:: test_fit_verity_sign
+ :synopsis:
+ :member-order: bysource
+ :members:
+ :undoc-members:
diff --git a/doc/develop/pytest/usage.rst b/doc/develop/pytest/usage.rst
index 6002244d608..a9b8b8bd610 100644
--- a/doc/develop/pytest/usage.rst
+++ b/doc/develop/pytest/usage.rst
@@ -411,7 +411,7 @@ The board can be switched off now.
Examples
''''''''
-https://source.denx.de/u-boot/u-boot-test-hooks contains some working example hook
+https://git.u-boot-project.org/u-boot/u-boot-test-hooks contains some working example hook
scripts, and may be useful as a reference when implementing hook scripts for
your platform. These scripts are not considered part of U-Boot itself.
diff --git a/doc/develop/release_cycle.rst b/doc/develop/release_cycle.rst
index a454d343676..d6b2d22697d 100644
--- a/doc/develop/release_cycle.rst
+++ b/doc/develop/release_cycle.rst
@@ -55,10 +55,10 @@ Current Status
* U-Boot v2026.07 was released on Monday, 06 July 2026.
-* The Merge Window for the next release (|next_ver|) is **open** until the -rc1
+* The Merge Window for the next release (|next_ver|) is **closed** with the -rc1
release on Monday, 27 July 2026.
-* The next branch is now **closed** until the -rc2 release on Monday, 10
+* The next branch is now **open** with the -rc2 release on Monday, 10
August 2026.
* Release "|next_ver|" is scheduled for Monday, 05 October 2026.
@@ -69,13 +69,13 @@ Future Releases
.. The following commented out dates are for when release candidates are
planned to be tagged.
-.. For the next scheduled release, release candidates were made on:
+For the next scheduled release, release candidates were made on:
-.. * U-Boot |next_ver|-rc1 was released on Mon 27 July 2026.
+* U-Boot |next_ver|-rc1 was released on Mon 27 July 2026.
-.. * U-Boot |next_ver|-rc2 was released on Mon 10 August 2026.
+* U-Boot |next_ver|-rc2 was released on Mon 10 August 2026.
-.. * U-Boot |next_ver|-rc3 was released on Mon 24 August 2026.
+* U-Boot |next_ver|-rc3 was released on Mon 24 August 2026.
.. * U-Boot |next_ver|-rc4 was released on Mon 07 September 2026.
@@ -96,7 +96,7 @@ Previous Releases
-----------------
Note: these statistics are generated by our fork of `gitdm
-<https://source.denx.de/u-boot/gitdm>`_, which was originally created by
+<https://git.u-boot-project.org/u-boot/gitdm>`_, which was originally created by
Jonathan Corbet.
* :doc:`statistics/u-boot-stats-v2026.07` which was released on 06 July 2026.
diff --git a/doc/develop/security.rst b/doc/develop/security.rst
index 84b130646f3..ed652ec756e 100644
--- a/doc/develop/security.rst
+++ b/doc/develop/security.rst
@@ -11,7 +11,7 @@ Contact
-------
The preferred initial point of contact is to send email to
-`[email protected]` and use `scripts/get_maintainers.pl` to also include any
+`[email protected]` and use `scripts/get_maintainers.pl` to also include any
relevant custodians. In addition, Tom Rini should be contacted at
diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst
index c3e0ef27824..b4f82eb18e1 100644
--- a/doc/develop/sending_patches.rst
+++ b/doc/develop/sending_patches.rst
@@ -5,7 +5,7 @@ Sending patches
*Before you begin* to implement any new ideas or concepts it is always a good
idea to present your plans on the `U-Boot mailing list
-<https://lists.denx.de/listinfo/u-boot>`_. U-Boot supports a huge amount of
+<https://lists.u-boot-project.org/mailman/listinfo/u-boot>`_. U-Boot supports a huge amount of
very different systems, and it is often impossible for the individual developer
to oversee the consequences of a specific change to all architectures.
Discussing concepts early can help you to avoid spending effort on code which,
@@ -15,7 +15,7 @@ resource - use it. Being familiar with the :doc:`process` is also important.
A good introduction how to prepare for submitting patches can be found in the
LWN article `How to Get Your Change Into the Linux Kernel
-<http://lwn.net/Articles/139918/>`_ as the same rules apply to U-Boot, too.
+<https://lwn.net/Articles/139918/>`_ as the same rules apply to U-Boot, too.
.. _b4_contrib:
@@ -25,7 +25,7 @@ Using b4
Use the `b4 <https://b4.docs.kernel.org/en/latest/>`__ tool to prepare and send
your patches. b4 has become the preferred tool to sending patches for many Linux
kernel contributors, and U-Boot ships with a ready-to-use ``.b4-config`` that
-targets ``[email protected]`` and integrates with ``scripts/get_maintainer.pl``
+targets ``[email protected]`` and integrates with ``scripts/get_maintainer.pl``
for recipient discovery.
Start a topical series with ``b4 prep`` and keep the commits organised with
@@ -51,7 +51,7 @@ additional runs.
When the series is ready, use ``b4 send``. Begin with ``--dry-run`` to review the
generated emails and ``--reflect`` to copy yourself for records before
-dispatching to ``[email protected]``.
+dispatching to ``[email protected]``.
.. code-block:: bash
@@ -86,8 +86,8 @@ patman now lives outside the U-Boot tree; install it with
General Patch Submission Rules
------------------------------
-* All patches must be sent to the `[email protected]
- <https://lists.denx.de/listinfo/u-boot>`_ mailing list.
+* All patches must be sent to the `[email protected]
+ <https://lists.u-boot-project.org/mailman/listinfo/u-boot>`_ mailing list.
* If your patch affects the code maintained by one of the :ref:`custodians`, CC
them when emailing your patch. The easiest way to make sure you don't forget
@@ -134,7 +134,7 @@ General Patch Submission Rules
patches is by using the ``git format-patch`` command. For a patch that is
fixing a bug or regression of some sort, please use the ``master`` branch of
the mainline U-Boot git repository located at
- https://source.denx.de/u-boot/u-boot.git as reference. For new features, if
+ https://git.u-boot-project.org/u-boot/u-boot.git as reference. For new features, if
the ``next`` branch has been opened (which happens with the release of
``-rc2``) that branch should be used, otherwise ``master`` is acceptable.
@@ -142,10 +142,6 @@ General Patch Submission Rules
like wrapping of longer lines etc.
The best way to send patches is by not using your regular mail tool, but by
using either ``git send-email`` or the ``git imap-send`` command instead.
- If you believe you need to use a mailing list for testing (instead of any
- regular mail address you own), we have a special test list for such purposes.
- It would be best to subscribe to the list for the duration of your tests to
- avoid repeated moderation - see https://lists.denx.de/listinfo/test
* Choose a meaningful Subject: - keep in mind that the Subject will also be
visible as headline of your commit message. Make sure the subject does not
@@ -317,7 +313,7 @@ to observe the following rules.
Note: it is *not* sufficient to provide a change log in some cover letter
that gets sent as a separate message with the patch series. The reason is
that such cover letters are not as easily reviewed in our `patchwork queue
- <http://patchwork.ozlabs.org/project/uboot/list/>`_ so they are not helpful
+ <https://patchwork.ozlabs.org/project/uboot/list/>`_ so they are not helpful
to any reviewers using this tool. Example::
From: Joe Hacker <[email protected]>
@@ -353,15 +349,15 @@ posted before, look up the old threads, and then manually compare if anything
has been changed, or what.
If you have problems with your e-mail client, for example because it mangles
-white space or wraps long lines, then please read this article about `Email
-Clients and Patches <http://kerneltrap.org/Linux/Email_Clients_and_Patches>`_.
+white space or wraps long lines, then please read this about `Email
+Clients and Patches <https://docs.kernel.org/process/email-clients.html>`_.
Notes
-----
1. U-Boot is Free Software that can redistributed and/or modified under the
terms of the `GNU General Public License
- <http://www.fsf.org/licensing/licenses/gpl.html>`_ (GPL). Currently (August
+ <https://www.gnu.org/licenses/old-licenses/gpl-2.0.html>`_ (GPL). Currently (August
2022) version 2 of the GPL applies. Please see :download:`Licensing
<../../Licenses/README>` for details. To allow that later versions of U-Boot
may be released under a later version of the GPL, all new code that gets
@@ -384,12 +380,12 @@ Notes
Patch Tracking
--------------
-Like some other projects, U-Boot uses `Patchwork <http://patchwork.ozlabs.org/>`__
+Like some other projects, U-Boot uses `Patchwork <https://patchwork.ozlabs.org/>`__
to track the state of patches. This is one of the reasons why it is mandatory
to submit all patches to the U-Boot mailing list - only then they will be
picked up by patchwork.
-At http://patchwork.ozlabs.org/project/uboot/list/ you can find the list of
+At https://patchwork.ozlabs.org/project/uboot/list/ you can find the list of
open U-Boot patches. By using the "Filters" link (Note: requires JavaScript)
you can also select other views, for example, to include old patches that have,
for example, already been applied or rejected.
@@ -474,14 +470,13 @@ Apply patches
^^^^^^^^^^^^^
To apply a patch from the `patchwork queue
-<http://patchwork.ozlabs.org/project/uboot/list/>`_ using ``git``, download the
+<https://patchwork.ozlabs.org/project/uboot/list/>`_ using ``git``, download the
mbox file and apply it using::
git am file
-The `openembedded wiki <http://wiki.openembedded.net/>`_ also provides a script
-named `pw-am.sh
-<http://cgit.openembedded.org/cgit.cgi/openembedded/tree/contrib/patchwork/pw-am.sh>`_
+OpenEmbedded also provides a script named `pw-am.sh
+<https://git.openembedded.org/openembedded/tree/contrib/patchwork/pw-am.sh>`_
which can be used to fetch an 'mbox' patch from patchwork and git am it::
usage: pw-am.sh <number>
@@ -500,7 +495,7 @@ The `pwclient` command line tool can be used for example to retrieve patches,
search the queue or update the state.
All necessary information for `pwclient` is linked from the bottom of
-http://patchwork.ozlabs.org/project/uboot/
+https://patchwork.ozlabs.org/project/uboot/
Use::
@@ -511,4 +506,4 @@ for an overview on how to use it.
pwparser
^^^^^^^^
-See http://www.mail-archive.com/[email protected]/msg00057.html
+See https://lists.ozlabs.org/pipermail/patchwork/2010-January/000186.html
diff --git a/doc/develop/tests_writing.rst b/doc/develop/tests_writing.rst
index 1a020caa411..1a6d13f6c7c 100644
--- a/doc/develop/tests_writing.rst
+++ b/doc/develop/tests_writing.rst
@@ -236,7 +236,7 @@ Include ``test/ut.h`` defines a number of macros to check values and to return
from the test function if the assertion fails. See :doc:`../api/test`
for details.
-[1] https://gitlab.denx.de/u-boot/u-boot/-/commit/9fe064646d2
+[1] https://git.u-boot-project.org/u-boot/u-boot/-/commit/9fe064646d
Add a new driver model test
@@ -282,7 +282,7 @@ implementations work as expected.
Example commit: c48cb7ebfb4 ("sandbox: add ADC unit tests") [1]
-[1] https://gitlab.denx.de/u-boot/u-boot/-/commit/c48cb7ebfb4
+[1] https://git.u-boot-project.org/u-boot/u-boot/-/commit/c48cb7ebfb4
Add a new test suite
diff --git a/doc/develop/uefi/iscsi.rst b/doc/develop/uefi/iscsi.rst
index 51d38cde243..104ef87705f 100644
--- a/doc/develop/uefi/iscsi.rst
+++ b/doc/develop/uefi/iscsi.rst
@@ -125,17 +125,17 @@ iPXE
For running iPXE on arm64 the bin-arm64-efi/snp.efi build target is needed::
- git clone http://git.ipxe.org/ipxe.git
+ git clone https://github.com/ipxe/ipxe
cd ipxe/src
make bin-arm64-efi/snp.efi -j6 EMBED=myscript.ipxe
The available commands for the boot script are documented at:
-http://ipxe.org/cmd
+https://ipxe.org/cmd
Credentials are managed as environment variables. These are described here:
-http://ipxe.org/cfg
+https://ipxe.org/cfg
iPXE by default will put the CPU to rest when waiting for input. U-Boot does
not wake it up due to missing interrupt support. To avoid this behavior create
diff --git a/doc/develop/uefi/u-boot_on_efi.rst b/doc/develop/uefi/u-boot_on_efi.rst
index 177e887ebd9..883bd2b1451 100644
--- a/doc/develop/uefi/u-boot_on_efi.rst
+++ b/doc/develop/uefi/u-boot_on_efi.rst
@@ -300,9 +300,9 @@ Content of **boot.scr**:
.. code-block:: bash
ext4load ${devtype} ${devnum}:${distro_bootpart} ${kernel_addr_r} ${prefix}Image
- setenv kernel_size ${filesize}
+ env set kernel_size ${filesize}
ext4load ${devtype} ${devnum}:${distro_bootpart} ${ramdisk_addr_r} ${prefix}Initrd
- setenv initrd_size ${filesize}
+ env set initrd_size ${filesize}
zboot ${kernel_addr_r} ${kernel_size} ${ramdisk_addr_r} ${initrd_size}
Extlinux configuration
diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
index 3ca22b572a9..94ddf690440 100644
--- a/doc/develop/uefi/uefi.rst
+++ b/doc/develop/uefi/uefi.rst
@@ -170,11 +170,11 @@ Sign an image with one of the keys in "db" on your host
Now in U-Boot install the keys on your board::
fatload mmc 0:1 <tmpaddr> PK.auth
- setenv -e -nv -bs -rt -at -i <tmpaddr>:$filesize PK
+ env set -e -nv -bs -rt -at -i <tmpaddr>:$filesize PK
fatload mmc 0:1 <tmpaddr> KEK.auth
- setenv -e -nv -bs -rt -at -i <tmpaddr>:$filesize KEK
+ env set -e -nv -bs -rt -at -i <tmpaddr>:$filesize KEK
fatload mmc 0:1 <tmpaddr> db.auth
- setenv -e -nv -bs -rt -at -i <tmpaddr>:$filesize db
+ env set -e -nv -bs -rt -at -i <tmpaddr>:$filesize db
Set up boot parameters on your board::
@@ -412,7 +412,7 @@ bit in OsIndications variable with
.. code-block:: console
- => setenv -e -nv -bs -rt -v OsIndications =0x0000000000000004
+ => env set -e -nv -bs -rt -v OsIndications =0x0000000000000004
Since U-Boot doesn't currently support SetVariable at runtime, its value
won't be taken over across the reboot. If this is the case, you can skip
@@ -698,12 +698,12 @@ end up with "host not found".
We need to preset the "httpserverip" environment variable to proceed the wget::
- setenv httpserverip 192.168.1.1
+ env set httpserverip 192.168.1.1
UEFI HTTP(s) Boot using lwIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Similar to the above U-Boot can do EFI HTTP boot using lwIP. If we combine this
-with Mbed TLS we can also download from https://
+with Mbed TLS we can also download from HTTPS.
HTTP(s) Boot can be activated by specifying::
@@ -789,7 +789,7 @@ If the environment variable is set to 'list' a list of all tests is shown.
Below you can find the output of an example session::
- => setenv efi_selftest simple network protocol
+ => env set efi_selftest simple network protocol
=> bootefi selftest
Testing EFI API implementation
Selected test: 'simple network protocol'